SanaShioriBuilder

SHIORI subsystem interface builder

Type parameters

State

Hierarchy

ShioriBuilder<State>
- SanaShioriBuilder

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SanaShioriBuilder(state?: State, middlewares?: ShioriMiddlewares<State>, check?: undefined | false | true): SanaShioriBuilder

Inherited from ShioriBuilder.__constructor
- Defined in D:/make/devel/sanajk/node_modules/shiorack/dist/lib/ShioriBuilder.d.ts:52
construct builder

Parameters
- Optional state: State
  
  state in context
- Optional middlewares: ShioriMiddlewares<State>
  
  middlewares
- Optional check: undefined | false | true
  
  check middlewares
Returns SanaShioriBuilder

Properties

load

load: Array<LoadMiddleware<State>>

load middlewares

request

request: Array<RequestMiddleware<State>>

request middlewares

state

state: State

state in context

unload

unload: Array<UnloadMiddleware<State>>

unload middlewares

Methods

build

build(): object

Inherited from ShioriBuilder.build
- Defined in D:/make/devel/sanajk/node_modules/shiorack/dist/lib/ShioriBuilder.d.ts:88
build SHIORI interface

Returns object
- load: function
  - - (dirpath: string): boolean | Promise<boolean>
    - Parameters
      - dirpath: string
      Returns boolean | Promise<boolean>
- request: function
  - - (requestStr: string | Request): Promise<string>
    - Parameters
      - requestStr: string | Request
      Returns Promise<string>
- unload: function
  - - (): void | Promise<void>
    - Returns void | Promise<void>

use

use(middleware: ShioriMiddleware<State>): SanaShioriBuilder<State>
use<AddState>(middleware: ShioriMiddlewareWithState<State, AddState>): SanaShioriBuilder<State & AddState>

Overrides ShioriBuilder.use
- Defined in SanaShioriBuilder.ts:77
add middleware

Parameters
- middleware: ShioriMiddleware<State>
  
  middleware with state
Returns SanaShioriBuilder<State>
Overrides ShioriBuilder.use
- Defined in SanaShioriBuilder.ts:78
Type parameters
- AddState
Parameters
- middleware: ShioriMiddlewareWithState<State, AddState>
Returns SanaShioriBuilder<State & AddState>

useAutoTalk

useAutoTalk(options?: Options<State>): SanaShioriBuilder<State & AutoTalksState<State>>

- Defined in SanaShioriBuilder.ts:65
must be after completeResponse

Parameters
- Default value options: Options<State> = {}
Returns SanaShioriBuilder<State & AutoTalksState<State>>

useCompleteResponse

useCompleteResponse(): SanaShioriBuilder<State & DefaultHeadersState>

- Defined in SanaShioriBuilder.ts:59
must be first one of request middlewares

Returns SanaShioriBuilder<State & DefaultHeadersState>

useDefaultEvent

useDefaultEvent(): SanaShioriBuilder<State>

- Defined in SanaShioriBuilder.ts:71
must be after completeResponse

Returns SanaShioriBuilder<State>

useDefaults

useDefaults<SaveData>(options?: UseDefaultOption<State>): SanaShioriBuilder<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState & EventsState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState> & AutoTalksState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState & EventsState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState>>>

- Defined in SanaShioriBuilder.ts:34
use default middlewares

Type parameters
- SaveData
Parameters
- Default value options: UseDefaultOption<State> = {}
Returns SanaShioriBuilder<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState & EventsState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState> & AutoTalksState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState & EventsState<State & DirpathState & SaveDataState<SaveData> & DefaultHeadersState>>>

useDirpath

useDirpath(): SanaShioriBuilder<State & DirpathState>

- Defined in SanaShioriBuilder.ts:55
any order

Returns SanaShioriBuilder<State & DirpathState>

useErrorResponse

useErrorResponse(): SanaShioriBuilder<State>

- Defined in SanaShioriBuilder.ts:61
must be after completeResponse

Returns SanaShioriBuilder<State>

useExit

useExit(): SanaShioriBuilder<State>

- Defined in SanaShioriBuilder.ts:53
must be first middleware

Returns SanaShioriBuilder<State>

useGenericEvent

useGenericEvent(events?: Events<State>): SanaShioriBuilder<State & EventsState<State>>

- Defined in SanaShioriBuilder.ts:69
must be after completeResponse

Parameters
- Optional events: Events<State>
Returns SanaShioriBuilder<State & EventsState<State>>

useLoad

useLoad(middleware: LoadMiddleware<State>): SanaShioriBuilder<State>
useLoad<AddState>(middleware: LoadMiddleware<State & AddState>, state: AddState): SanaShioriBuilder<State & AddState>

Overrides ShioriBuilder.useLoad
- Defined in SanaShioriBuilder.ts:98
add load middleware

Parameters
- middleware: LoadMiddleware<State>
  
  middleware
Returns SanaShioriBuilder<State>
Overrides ShioriBuilder.useLoad
- Defined in SanaShioriBuilder.ts:99
Type parameters
- AddState
Parameters
- middleware: LoadMiddleware<State & AddState>
- state: AddState
Returns SanaShioriBuilder<State & AddState>

useRequest

useRequest(middleware: RequestMiddleware<State>): SanaShioriBuilder<State>
useRequest<AddState>(middleware: RequestMiddleware<State & AddState>, state: AddState): SanaShioriBuilder<State & AddState>

Overrides ShioriBuilder.useRequest
- Defined in SanaShioriBuilder.ts:110
add request middleware

Parameters
- middleware: RequestMiddleware<State>
  
  middleware
Returns SanaShioriBuilder<State>
Overrides ShioriBuilder.useRequest
- Defined in SanaShioriBuilder.ts:111
Type parameters
- AddState
Parameters
- middleware: RequestMiddleware<State & AddState>
- state: AddState
Returns SanaShioriBuilder<State & AddState>

useSaveLoad

useSaveLoad<SaveData>(filename?: string): SanaShioriBuilder<State & SaveDataState<SaveData>>

- Defined in SanaShioriBuilder.ts:57
any order

Type parameters
- SaveData
Parameters
- Default value filename: string = "save.json"
Returns SanaShioriBuilder<State & SaveDataState<SaveData>>

useSender

useSender(): SanaShioriBuilder<State>

- Defined in SanaShioriBuilder.ts:63
must be after completeResponse

Returns SanaShioriBuilder<State>

useUnload

useUnload(middleware: UnloadMiddleware<State>): SanaShioriBuilder<State>
useUnload<AddState>(middleware: UnloadMiddleware<State & AddState>, state: AddState): SanaShioriBuilder<State & AddState>

Overrides ShioriBuilder.useUnload
- Defined in SanaShioriBuilder.ts:122
add unload middleware

Parameters
- middleware: UnloadMiddleware<State>
  
  middleware
Returns SanaShioriBuilder<State>
Overrides ShioriBuilder.useUnload
- Defined in SanaShioriBuilder.ts:123
Type parameters
- AddState
Parameters
- middleware: UnloadMiddleware<State & AddState>
- state: AddState
Returns SanaShioriBuilder<State & AddState>

Type parameters

State

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional state: State

Optional middlewares: ShioriMiddlewares<State>

Optional check: undefined | false | true

Returns SanaShioriBuilder

Properties

load

request

state

unload

Methods

build

Returns object

load: function

Parameters

dirpath: string

Returns boolean | Promise<boolean>

request: function

Parameters

requestStr: string | Request

Returns Promise<string>

unload: function

Returns void | Promise<void>

use

Parameters

middleware: ShioriMiddleware<State>

Returns SanaShioriBuilder<State>

Type parameters

AddState

Parameters

middleware: ShioriMiddlewareWithState<State, AddState>

Returns SanaShioriBuilder<State & AddState>

useAutoTalk

Parameters

Default value options: Options<State> = {}

Returns SanaShioriBuilder<State & AutoTalksState<State>>

useCompleteResponse

Returns SanaShioriBuilder<State & DefaultHeadersState>

useDefaultEvent

Returns SanaShioriBuilder<State>

useDefaults

Type parameters

SaveData

Parameters

Default value options: UseDefaultOption<State> = {}

useDirpath

Returns SanaShioriBuilder<State & DirpathState>

useErrorResponse

Returns SanaShioriBuilder<State>

useExit

Returns SanaShioriBuilder<State>

useGenericEvent

Parameters

Optional events: Events<State>

Returns SanaShioriBuilder<State & EventsState<State>>

useLoad

Parameters

middleware: LoadMiddleware<State>

Returns SanaShioriBuilder<State>

Type parameters

AddState

Parameters

middleware: LoadMiddleware<State & AddState>

state: AddState

Returns SanaShioriBuilder<State & AddState>

useRequest

Parameters

middleware: RequestMiddleware<State>

Returns SanaShioriBuilder<State>

Type parameters

AddState