Variable requestLocalSocket

Type Declaration

• • (
        socketPath: string,
        path: string,
        options?: { method?: string; timeoutMs?: number },
    ): Promise<
        {
            body: Buffer;
            headers: any;
            kind: string;
            ok: boolean;
            status: number;
            url: string;
            why: string;
        },
    >

  • Makes a request over a local Unix socket an administrator named, such as the Docker Engine API, under the kill switch, body cap and timeout.

    Never rejects.

    Parameters

    • socketPath: string

      the socket's path

    • path: string

      the request path

    • Optionaloptions: { method?: string; timeoutMs?: number }

      method and timeoutMs

    Returns Promise<
        {
            body: Buffer;
            headers: any;
            kind: string;
            ok: boolean;
            status: number;
            url: string;
            why: string;
        },
    >

    a promise of { ok, status, body, headers, kind, why, url }