Properties
Protected baseRoute
baseRoute: Router
Protected store
Methods
addRoute
- addRoute(method: Methods, path: string, handler: ((req: ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>, res: Response<any, Record<string, any>>, next?: NextFunction) => void | Promise<void>), fnName?: string): void
-
Parameters
-
-
path: string
-
handler: ((req: ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>, res: Response<any, Record<string, any>>, next?: NextFunction) => void | Promise<void>)
-
- (req: ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>, res: Response<any, Record<string, any>>, next?: NextFunction): void | Promise<void>
-
Parameters
-
req: ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>
-
res: Response<any, Record<string, any>>
-
Optional next: NextFunction
Returns void | Promise<void>
-
Optional fnName: string
Returns void
close
- close(): Promise<void>
-
Returns Promise<void>
Protected onError
- onError(err: Error | IApiError | [Error | IApiError, Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> | ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>], _req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, _next: NextFunction): void
-
Parameters
-
err: Error | IApiError | [Error | IApiError, Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> | ProvisioningRequest<{
[key: string]: string;
}, any, any, ParsedQs>]
-
_req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
-
res: Response<any, Record<string, any>>
-
_next: NextFunction
Returns void
start
- start(port: number, hostname?: string, backlog?: number): Promise<void>
-
Parameters
-
port: number
-
hostname: string = "0.0.0.0"
-
backlog: number = 10
Returns Promise<void>
The provisioning API serves two classes of clients: