Class SchemaHandlerStore

Schema handler store. This store keeps the registered schema handlers. Go through the Mesh API to register a schema handler.

Hierarchy

SchemaHandlerStore

Index

Methods

Methods

registerSchemaHandler

registerSchemaHandler<T>(schema: string, handler: IMeshSchemaHandler<T>): void

- Defined in lib/meshHandlerStore.ts:47
Register a schema handler.

Type parameters
- T
Parameters
- schema: string
  
  The schema, the handler should be registered for.
- handler: IMeshSchemaHandler<T>
  
  The handler, that should be registered.
Returns void

unregisterSchemaHandler

unregisterSchemaHandler<T>(schema: string, handler: IMeshSchemaHandler<T>): void

- Defined in lib/meshHandlerStore.ts:61
Unregister a schema handler.

Type parameters
- T
Parameters
- schema: string
  
  The schema, the handler should unregistered from.
- handler: IMeshSchemaHandler<T>
  
  The handler, that should be unregistered.
Returns void

workSchemaHandlers

workSchemaHandlers<T>(schema: string, item: IMeshNode<T>, req?: IMeshRequest, res?: IMeshResponse): Promise<IMeshNode<T>>

- Defined in lib/meshHandlerStore.ts:79
Executes the schema handlers for a passed MeshNode.

Type parameters
- T
Parameters
- schema: string
  
  The schema, for which the handlers should be executed.
- item: IMeshNode<T>
  
  The MeshNode, that should be processed in the handlers.
- Optional req: IMeshRequest
  
  The MeshRequest.
- Optional res: IMeshResponse
  
  The MeshResponse
Returns Promise<IMeshNode<T>>

A promise, that will be fulfilled, once all the handlers have been processed and will be rejected if executing a handler fails.

Generated using TypeDoc