Function $protocol

  • $protocol(context?: string | NextContext<NextIdentity<any>>, service?: string, options?: { body?: any; isProd?: boolean; param?: any }): { asTargetUrl: (() => string); enqueue: (<T>(param?: any, body?: any, mode?: string, callback?: string, delaySeconds?: number) => Promise<string>); execute: (<T>(param?: any, body?: any, mode?: string) => Promise<T>); hello: (() => string); notify: ((param?: any, body?: any, mode?: string, callback?: string) => Promise<string>) }

  • builder to support protocol-service.

    Parameters

    • context: string | NextContext<NextIdentity<any>> = {}

      the current context (or service name).

    • Optional service: string

      service name

    • Optional options: { body?: any; isProd?: boolean; param?: any }

      additional options.

      • Optional body?: any
      • Optional isProd?: boolean
      • Optional param?: any

    Returns { asTargetUrl: (() => string); enqueue: (<T>(param?: any, body?: any, mode?: string, callback?: string, delaySeconds?: number) => Promise<string>); execute: (<T>(param?: any, body?: any, mode?: string) => Promise<T>); hello: (() => string); notify: ((param?: any, body?: any, mode?: string, callback?: string) => Promise<string>) }

    • asTargetUrl: (() => string)
        • (): string

        • Returns string

    • enqueue: (<T>(param?: any, body?: any, mode?: string, callback?: string, delaySeconds?: number) => Promise<string>)
        • <T>(param?: any, body?: any, mode?: string, callback?: string, delaySeconds?: number): Promise<string>

        • Type Parameters

          • T = any

          Parameters

          • Optional param: any
          • Optional body: any
          • mode: string = 'POST'
          • Optional callback: string
          • delaySeconds: number = 1

          Returns Promise<string>

    • execute: (<T>(param?: any, body?: any, mode?: string) => Promise<T>)
        • <T>(param?: any, body?: any, mode?: string): Promise<T>

        • Type Parameters

          • T = any

          Parameters

          • Optional param: any
          • Optional body: any
          • mode: string = 'POST'

          Returns Promise<T>

    • hello: (() => string)
        • (): string

        • Returns string

    • notify: ((param?: any, body?: any, mode?: string, callback?: string) => Promise<string>)
        • (param?: any, body?: any, mode?: string, callback?: string): Promise<string>

        • Parameters

          • Optional param: any
          • Optional body: any
          • mode: string = 'POST'
          • Optional callback: string

          Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc