Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ActionProcessor<ActionClass>

Type parameters

Hierarchy

  • ActionProcessor

Index

Constructors

constructor

  • Type parameters

    • ActionClass: Action<ActionClass>

    Parameters

    Returns ActionProcessor<ActionClass>

Properties

action

action: ActionClass["name"]

actionStartTime

actionStartTime: number

actionStatus

actionStatus: string | Error

actionTemplate

actionTemplate: ActionClass

connection

connection: Connection

duration

duration: number

messageId

messageId: string | number

missingParams

missingParams: string[]

params

params: { action: string; apiVersion: string | number }

Type declaration

  • [key: string]: any
  • action: string
  • apiVersion: string | number

response

response: {}

Type declaration

  • [key: string]: any

session

session: any

toProcess

toProcess: boolean

toRender

toRender: boolean

validatorErrors

validatorErrors: (string | Error)[]

working

working: boolean

Methods

Private applyDefaultErrorLogLineFormat

  • applyDefaultErrorLogLineFormat(error: any): { errorFields: { error: string } }
  • Parameters

    • error: any

    Returns { errorFields: { error: string } }

    • errorFields: { error: string }
      • error: string

Private completeAction

  • completeAction(status?: string | Error): Promise<ActionProcessor<ActionClass>>
  • Parameters

    • Optional status: string | Error

    Returns Promise<ActionProcessor<ActionClass>>

getPendingActionCount

  • getPendingActionCount(): number
  • Returns number

Private incrementPendingActions

  • incrementPendingActions(count?: number): void
  • Parameters

    • count: number = 1

    Returns void

Private incrementTotalActions

  • incrementTotalActions(count?: number): void
  • Parameters

    • count: number = 1

    Returns void

lockParams

  • lockParams(): void
  • Returns void

Private logAndReportAction

  • logAndReportAction(error: any): void
  • Parameters

    • error: any

    Returns void

Private postProcessAction

  • postProcessAction(): Promise<void>
  • Returns Promise<void>

Private preProcessAction

  • preProcessAction(): Promise<void>
  • Returns Promise<void>

Private prepareStringMethod

  • prepareStringMethod(method: string): Function
  • Parameters

    • method: string

    Returns Function

processAction

  • processAction(actionName?: string, apiVersion?: string | number): Promise<ActionProcessor<ActionClass>>
  • Parameters

    • Optional actionName: string
    • apiVersion: string | number = ...

    Returns Promise<ActionProcessor<ActionClass>>

Private reduceParams

  • reduceParams(schemaKey?: string): void
  • Parameters

    • Optional schemaKey: string

    Returns void

Private runAction

  • Returns Promise<ActionProcessor<ActionClass>>

Private validateParam

  • validateParam(props: any, params: any, key: any, schemaKey: any): Promise<void>
  • Parameters

    • props: any
    • params: any
    • key: any
    • schemaKey: any

    Returns Promise<void>

Private validateParams

  • validateParams(schemaKey?: string): Promise<void>
  • Parameters

    • Optional schemaKey: string

    Returns Promise<void>

Generated using TypeDoc