wind-waker

Classes#

Type aliases#

Action#

Ƭ Action<T>: (input: T, ctx: Context<T>) => any | void

Type parameters#

Name	Type
`T`	`any`

Type declaration#

▸ (input, ctx): any | void

Parameters#

Name	Type
`input`	`T`
`ctx`	`Context`<`T`>

Returns#

any | void

Defined in#

actions/actions.types.ts:5

ActionConfig#

Ƭ ActionConfig: Object

Type declaration#

Name	Type
`fn`	`Action`
`pipes`	`Pipe`[]

Defined in#

actions/actions.types.ts:7

Actions#

Ƭ Actions: Map<string, ActionConfig>

Defined in#

actions/actions.ts:4

Context#

Ƭ Context<T>: { code?: number ; input?: T ; rawBody: string ; req: IncomingMessage & Record<string, any> ; res: ServerResponse & Record<string, any> ; url: URL } & Record<string, any>

Type parameters#

Name	Type
`T`	`any`

Defined in#

context/context.ts:4

Pipe#

Ƭ Pipe: (ctx: Context) => void | Promise<any> | any

Type declaration#

▸ (ctx): void | Promise<any> | any

Parameters#

Name	Type
`ctx`	`Context`

Returns#

void | Promise<any> | any

Defined in#

pipes/pipe.ts:9

Functions#

$code#

▸ Const $code(statusCode): (__namedParameters: Context<any>) => void

Parameters#

Name	Type
`statusCode`	`number`

Returns#

fn

▸ (__namedParameters): void

Parameters#

Name	Type
`__namedParameters`	`Context`<`any`>

Returns#

void

Defined in#

pipes/code.ts:3

$cors#

▸ Const $cors(options?): (__namedParameters: Object) => void

Parameters#

Name	Type
`options`	`CorsOptions`

Returns#

fn

▸ (__namedParameters): void

Parameters#

Name	Type
`__namedParameters`	`Object`

Returns#

void

Defined in#

pipes/third-party/cors.ts:4

$helmet#

▸ Const $helmet(options?): Pipe

Parameters#

Name	Type
`options`	`HelmetOptions`

Returns#

Pipe

Defined in#

pipes/third-party/helmet.ts:28

action#

▸ action(name, fn, pipes?): void

Parameters#

Name	Type	Default value
`name`	`string`	`undefined`
`fn`	`Action`	`undefined`
`pipes`	`Pipe`[]	`[]`

Returns#

void

Defined in#

actions/actions.ts:7

end#

▸ Const end(): Promise<App>

Returns#

Promise<App>

Defined in#

server/server.ts:93

express#

▸ Const express(pipe): Pipe

Provides compatibility with express middlewares

Parameters#

Name	Type
`pipe`	`ExpressMiddleware`

Returns#

Pipe

Defined in#

pipes/pipe.ts:16

setPipes#

▸ Const setPipes(fn, pipes?): Pipe[]

Parameters#

Name	Type	Default value
`fn`	`Action`<`any`>	`undefined`
`pipes`	`Pipe`[]	`[]`

Returns#

Pipe[]

Defined in#

pipes/pipe.ts:11

start#

▸ Const start(port?, options?): Promise<App>

Parameters#

Name	Type	Default value
`port`	`number`	`4000`
`options`	`AppOptions`	`{}`

Returns#

Promise<App>

Defined in#

server/server.ts:86