@goa/goa/types/typedefs/response.js

The Goa Source Code For Compilation Into @Goa/Koa That Includes Modules, Tests, Types And Dependencies.

export {}

/* typal types/Response.xml namespace */
/**
 * @typedef {import('http').IncomingMessage} http.IncomingMessage
 * @typedef {import('http').ServerResponse} http.ServerResponse
 * @typedef {import('stream').Stream} stream.Stream
 * @typedef {import('net').Socket} net.Socket
 * @typedef {import('..').Application} _goa.Application
 * @typedef {import('..').Context} _goa.Context
 * @typedef {import('..').Request} _goa.Request
 * @typedef {_goa.ContextDelegatedResponse} ContextDelegatedResponse `＠interface` The response API available via Context.
 * @typedef {Object} _goa.ContextDelegatedResponse `＠interface` The response API available via Context.
 * @prop {number} status Get/set response status code.
 * @prop {string} message Get/set response status message.
 * @prop {string|!Buffer|Object|!stream.Stream} body Get/set response body.
 * @prop {?number} length Return parsed response `Content-Length` when present. Set `Content-Length` field to `n`.
 * @prop {string} type Return the response mime type void of parameters such as "charset". Set Content-Type response header with `type` through `mime.lookup()` when it does not contain a charset.
 * ```js
 * ctx.response.type = '.html'
 * ctx.response.type = 'html'
 * ctx.response.type = 'json'
 * ctx.response.type = 'application/json'
 * ctx.response.type = 'png'
 * ```
 * @prop {boolean} writable Checks if the request is writable. Tests for the existence of the socket as _Node.JS_ sometimes does not set it.
 * @prop {string|Date} lastModified Get the Last-Modified date in Date form, if it exists. Set the Last-Modified date using a string or a Date.
 * ```js
 * ctx.response.lastModified = new Date()
 * ctx.response.lastModified = '2013-09-13'
 * ```
 * @prop {boolean} headerSent Check if a header has been written to the socket.
 * @prop {string} etag Get/Set the ETag of a response. This will normalize the quotes if necessary.
 * ```js
 * ctx.response.etag = 'md5hashsum'
 * ctx.response.etag = '"md5hashsum"'
 * ctx.response.etag = 'W/"123456789"'
 * ```
 * @prop {(filename?: string, options?: !_goa.ContentDisposition) => void} attachment Set _Content-Disposition_ header to "attachment" with optional `filename`.
 * @prop {(url: string, referrer?: string) => void} redirect Perform a 302 redirect to `url`. The string "back" is special-cased to provide Referrer support, when Referrer is not present `alt` or "/" is used.
 * ```js
 * ctx.response.redirect('back')
 * ctx.response.redirect('back', '/index.html')
 * ctx.response.redirect('/login')
 * ctx.response.redirect('http://google.com')
 * ```
 * @prop {(field: string) => void} remove Remove header `field`.
 * @prop {(field: (string|!Object), val?: (string|!Array|number)) => void} set Set header `field` to `val`, or pass an object of header fields.
 * ```js
 * ctx.response.set('Foo', ['bar', 'baz'])
 * ctx.response.set('Accept', 'application/json')
 * ctx.response.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' })
 * ```
 * @prop {(field: string) => void} vary Vary on `field`.
 * @prop {(field: string, val: (string|!Array)) => void} append Append additional header `field` with value `val`.
 * ```js
 * ctx.response.append('Link', [
 *   '<http://localhost>',
 *   '<http://localhost:3000>',
 * ])
 * ctx.response.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly')
 * ctx.response.append('Warning', '199 Miscellaneous warning')
 * ```
 * @prop {() => void} flushHeaders Flush any set headers, and begin the body.
 * @typedef {_goa.BaseResponse} BaseResponse `＠interface` The additional API not available via Context.
 * @typedef {_goa.ContextDelegatedResponse & _goa.$BaseResponse} _goa.BaseResponse `＠interface` The additional API not available via Context.
 * @typedef {Object} _goa.$BaseResponse `＠interface` The additional API not available via Context.
 * @prop {!net.Socket} socket Return the request socket.
 * @prop {!Object<string, string>} header Return response header (_OutgoingHttpHeaders_).
 * @prop {!Object<string, string>} headers Return response header, alias as `response.header` (_OutgoingHttpHeaders_).
 * @prop {(header: string) => string} get Return response header.
 * ```js
 * ctx.response.get('Content-Type') // => "text/plain"
 * ctx.response.get('content-type') // => "text/plain"
 * ```
 * @prop {(type: (!Array<string>|string), ...types: string[]) => (string|boolean)} is Check whether the response is one of the listed types. Pretty much the same as `this.request.is()`.
 * @typedef {_goa.Response} Response `＠interface` The response object.
 * @typedef {_goa.BaseResponse & _goa.$Response} _goa.Response `＠interface` The response object.
 * @typedef {Object} _goa.$Response `＠interface` The response object.
 * @prop {!_goa.Application} app The reference to the application.
 * @prop {!_goa.Context} ctx The reference to the context instance.
 * @prop {!_goa.Request} request The reference to the request instance.
 * @prop {!http.IncomingMessage} req The message from the client.
 * @prop {!http.ServerResponse} res The response from the server.
 * @typedef {_goa.ContentDisposition} ContentDisposition `＠record` Options for setting the attachment.
 * @typedef {Object} _goa.ContentDisposition `＠record` Options for setting the attachment.
 * @prop {string} [type="attachment"] The type. Default `attachment`.
 * @prop {boolean|string} [fallback=true] Fallback filename. Default `true`.
 */