Skip to main content

modules

hotstaq / Modules

hotstaq

Table of contents​

Enumerations​

Classes​

Interfaces​

Type aliases​

Type aliases​

APItoLoad​

Ƭ APItoLoad: Object

The API to load.

Type declaration​

NameType
exportedClassNamestring
pathstring

Defined in​

HotAPI.ts:14

HotTestPath​

Ƭ HotTestPath: (driver: HotTestDriver, ...args: any) => Promise<any>

Type declaration​

â–¸ (driver, ...args): Promise<any>

Create a test path for later execution.

Parameters​
NameType
driverHotTestDriver
...argsany
Returns​

Promise<any>

Defined in​

HotTestMap.ts:8

ServerAuthorizationFunction​

Ƭ ServerAuthorizationFunction: (req: any, res: any, jsonObj: any, queryObj: any) => Promise<any>

Type declaration​

â–¸ (req, res, jsonObj, queryObj): Promise<any>

A function that will be executed by the server for authorization. Any value returned from this function will be passed to the ServerExecutionFunction. If an undefined value is returned, this indicates the server was not able to authenticate the user, so the ServerExecutionFunction will not be executed.

Parameters​
NameType
reqany
resany
jsonObjany
queryObjany
Returns​

Promise<any>

Defined in​

HotRouteMethod.ts:36

ServerExecutionFunction​

Ƭ ServerExecutionFunction: (req: any, res: any, authorizedValue: any, jsonObj: any, queryObj: any) => Promise<any>

Type declaration​

â–¸ (req, res, authorizedValue, jsonObj, queryObj): Promise<any>

A function that will be executed by the server.

Parameters​
NameType
reqany
resany
authorizedValueany
jsonObjany
queryObjany
Returns​

Promise<any>

Defined in​

HotRouteMethod.ts:23