Class Health

See

https://docs.kutt.it/#tag/health

Example

const health = new Health(config);

Hierarchy

Constructors

constructor

Properties

#request config prefix

Methods

check delete get patch post request url

Constructors

constructor

Properties

Private #request

#request: {
    (options: string | RequestOptions | URL, callback?: ((res: IncomingMessage) => void)): ClientRequest;
    (url: string | URL, options: RequestOptions, callback?: ((res: IncomingMessage) => void)): ClientRequest;
} | {
    (options: string | RequestOptions | URL, callback?: ((res: IncomingMessage) => void)): http.ClientRequest;
    (url: string | URL, options: RequestOptions, callback?: ((res: IncomingMessage) => void)): http.ClientRequest;
}

Protected Readonly config

config: ConfigI

Protected Readonly prefix

prefix: "/health" = "/health"

Methods

check

  • Checks API health.

    Example

    const isHealthy = await health.check();

    Returns Promise<boolean>

Protected delete

  • Protected

    Type Parameters

    • Response = unknown

    Parameters

    • Optional url: string

    Returns Promise<Response>

Protected get

  • Protected

    =

    Type Parameters

    • Response = unknown

    Parameters

    • Optional url: string

    Returns Promise<Response>

  • Protected

    Type Parameters

    • Response = unknown

    Parameters

    • params: ParamsT
    • Optional url: string

    Returns Promise<Response>

Protected patch

  • Protected

    Type Parameters

    • Response = unknown

    Parameters

    • data: BodyT
    • Optional url: string

    Returns Promise<Response>

Protected post

  • Protected

    Type Parameters

    • Response = unknown

    Parameters

    • data: BodyT
    • Optional url: string

    Returns Promise<Response>

Protected request

Protected url

  • Protected

    Parameters

    • url: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc