Project shiorack

Index

Classes

ShioriBuilder

Interfaces

Type aliases

Functions

Type aliases

LoadMiddleware

LoadMiddleware<State>: Middleware<LoadContext<State>, LoadResult>

Type parameters

State

LoadResult

LoadResult: boolean

Middleware

Middleware<Context, Result>: (context: Context, next: NextStack<Result>) => MiddlewareResult<Result>

middleware

Type parameters

Context
Result

Type declaration

- (context: Context, next: NextStack<Result>): MiddlewareResult<Result>
- Parameters
  - context: Context
  - next: NextStack<Result>
  Returns MiddlewareResult<Result>

MiddlewareResult

MiddlewareResult<Result>: Result | Promise<Result>

middleware result

Type parameters

Result

NextStack

NextStack<Result>: () => MiddlewareResult<Result>

next()

Type parameters

Result

Type declaration

- (): MiddlewareResult<Result>
- Returns MiddlewareResult<Result>

RequestMiddleware

RequestMiddleware<State>: Middleware<RequestContext<State>, RequestResult>

Type parameters

State

RequestResult

RequestResult: ShioriJK.Message.Response

UnloadContext

UnloadContext<State>: BaseContext<State>

unload() context

Type parameters

State

UnloadMiddleware

UnloadMiddleware<State>: Middleware<UnloadContext<State>, UnloadResult>

Type parameters

State

UnloadResult

UnloadResult: void

Functions

addMiddleware

addMiddleware(middlewares: Middleware<any, any>[], middleware: Middleware<any, any>): Middleware<any, any>[]

- Defined in addMiddleware.ts:16
add middleware with type check

Parameters
- middlewares: Middleware<any, any>[]
- middleware: Middleware<any, any>
  
  middleware
Returns Middleware<any, any>[]

checkMiddleware

checkMiddleware<T>(middleware: T): void

- Defined in addMiddleware.ts:7
check middleware type

Type parameters
- T
Parameters
- middleware: T
  
  middleware
Returns void

compose

compose<Context, Result>(middlewares: Middleware<Context, Result>[]): Middleware<Context, Result>

- Defined in compose.ts:7
compose middlewares

Type parameters
- Context
- Result
Parameters
- middlewares: Middleware<Context, Result>[]
Returns Middleware<Context, Result>

Generated using TypeDoc