Interface ClientRequest<Req>

Represents a client for making requests to a service provider.

Param: Res

The type of the response payload.

interface ClientRequest<Req> {
    body?: Req;
    contentType?: string;
    headers?: Record<string, any>;
    method: "GET" | "POST";
    originMethod?: string;
    overrides?: ClientHeadersType & {
        API_KEY?: string;
        WITH_CREDENTIALS?: boolean;
    } & {
        AUTH_TOKEN?: string;
    };
    params?: any;
    url: string;
}

Type Parameters

  • Req

    The type of the request payload.

Properties

body? contentType? headers? method originMethod? overrides? params? url

Properties

Optionalbody

body?: Req

OptionalcontentType

contentType?: string

Optionalheaders

headers?: Record<string, any>

method

method: "GET" | "POST"

OptionaloriginMethod

originMethod?: string

Optionaloverrides

overrides?: ClientHeadersType & {
    API_KEY?: string;
    WITH_CREDENTIALS?: boolean;
} & {
    AUTH_TOKEN?: string;
}

Optionalparams

params?: any

url

url: string

Settings

Member Visibility

On This Page

Properties