Interface ScriptResponse

Minimal Express Response surface available to custom request handlers (a subset of Express's Response). Write the HTTP response through this object, e.g. api.res.status(200).json({ ok: true }).

interface ScriptResponse {
    end(): void;
    json(body: unknown): ScriptResponse;
    redirect(url: string): void;
    send(body?: unknown): ScriptResponse;
    set(field: string, value?: string): ScriptResponse;
    setHeader(name: string, value: string | string[]): ScriptResponse;
    status(code: number): ScriptResponse;
}

Index

Methods

end json redirect send set setHeader status

Methods

end

end(): void
Ends the response without further data.

Returns void
- Defined in packages/commons/dist/lib/script_api.d.ts:987

json

json(body: unknown): ScriptResponse
Sends a JSON response and ends the response.
Parameters
- body: unknown
Returns ScriptResponse
- Defined in packages/commons/dist/lib/script_api.d.ts:979

redirect

redirect(url: string): void
Redirects to the given URL.
Parameters
- url: string
Returns void
- Defined in packages/commons/dist/lib/script_api.d.ts:985

send

send(body?: unknown): ScriptResponse
Sends the response body (string, Buffer, object, …) and ends the response.
Parameters
- Optionalbody: unknown
Returns ScriptResponse
- Defined in packages/commons/dist/lib/script_api.d.ts:977

set

set(field: string, value?: string): ScriptResponse
Sets a response header (Express alias of setHeader, chainable).
Parameters
- field: string
- Optionalvalue: string
Returns ScriptResponse
- Defined in packages/commons/dist/lib/script_api.d.ts:983

setHeader

setHeader(name: string, value: string | string[]): ScriptResponse
Sets a response header (chainable).
Parameters
- name: string
- value: string | string[]
Returns ScriptResponse
- Defined in packages/commons/dist/lib/script_api.d.ts:981

status

status(code: number): ScriptResponse
Sets the HTTP status code (chainable).
Parameters
- code: number
Returns ScriptResponse
- Defined in packages/commons/dist/lib/script_api.d.ts:975