Class ClientRequest<Request, Response>Internal

Class representing a single request from the SockDaemonClient

Created by SockDaemonClient#request

Type Parameters

Hierarchy

  • ClientRequest

Constructors

constructor

Properties

#onAbort #onFinish #reject? #resolve? #signal? id promise request response?

Methods

reject resolve

Constructors

constructor

  • Type Parameters

    Parameters

    • request: Request

      Request to be sent

    • signal: undefined | AbortSignal

      Signal to abort the request

    • onFinish: (() => void)

      Called on either success or failure

        • (): void

        • Called on either success or failure

          Returns void

    Returns ClientRequest<Request, Response>

Properties

Private #onAbort

#onAbort: ((er) => void)

Type declaration

    • (er): void

    • Parameters

      • er: any

      Returns void

Private #onFinish

#onFinish: (() => void)

Type declaration

    • (): void

    • Returns void

Private Optional #reject

#reject?: ((er) => void)

Type declaration

    • (er): void

    • Parameters

      • er: any

      Returns void

Private Optional #resolve

#resolve?: ((r) => void)

Type declaration

    • (r): void

    • Parameters

      • r: Response

      Returns void

Private Optional #signal

#signal?: AbortSignal

id

id: string

Message ID request/response

promise

promise: Promise<Response>

Promise which resolves when the response is received

request

request: Request

The request sent to the Daemon

Optional response

response?: Response

The response returned by the Daemon, if resolved

Methods

reject

  • Cancel the request and fail the promise

    Parameters

    • er: any

    Returns void

resolve

  • Resolve the request with a response

    Parameters

    • r: Response

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc