Module api/v1/routes/daemons/utils

Index

Functions

Functions

checkDaemonToken

checkDaemonToken(ctx: DaemonOpHandlerCtx): void

- Defined in src/api/v1/routes/daemons/utils.ts:44
Checks a daemon token for validity in conjunction with performDaemonOp, and terminates the request if it is invalid or not present..

Parameters
- ctx: DaemonOpHandlerCtx
  
  DaemonOpCtx
Returns void

genericOpHandler

genericOpHandler(ctx: DaemonOpCtx, params: DaemonOpParams): Promise<void>

- Defined in src/api/v1/routes/daemons/utils.ts:95
Express-pluggable HTTP request handler for generic daemon operations.

Parameters
- ctx: DaemonOpCtx
  
  DaemonOpCtx
- params: DaemonOpParams
  
  DaemonOpParams
Returns Promise<void>

handleDaemonResponse

handleDaemonResponse(opCode: DaemonOpCode, daemonRes: AxiosResponse, req: ExpressHandlerRequest, res: Response): void

- Defined in src/api/v1/routes/daemons/utils.ts:62
Handles response codes from the daemon in accordance with the spec.

see

https://mergemocha.github.io/remotr-api-spec

Parameters
- opCode: DaemonOpCode
  
  DaemonOpCode
- daemonRes: AxiosResponse
  
  Daemon HTTP server response (An {@link AxiosResponse})
- req: ExpressHandlerRequest
  
  Express request object.
- res: Response
  
  Express response object.
Returns void

performDaemonOp

performDaemonOp(ctx: DaemonOpCtx, op: (ctx: DaemonOpHandlerCtx) => void | Promise<void>): Promise<void>

- Defined in src/api/v1/routes/daemons/utils.ts:17
Performs a DaemonOpCode operation as specified by the user, validating that the target daemon exists and catching any errors.

Parameters
- ctx: DaemonOpCtx
  
  DaemonOpCtx
- op: (ctx: DaemonOpHandlerCtx) => void | Promise<void>
  
  Operation executor function.
  - - (ctx: DaemonOpHandlerCtx): void | Promise<void>
    - Parameters
      - ctx: DaemonOpHandlerCtx
      Returns void | Promise<void>
Returns Promise<void>

Generated using TypeDoc