Interface InternalRequestOptions<B>

Represents the data that will be sent to the endpoint.

interface InternalRequestOptions<B = unknown> {
    authPrefix?: string;
    body?: B;
    enforceAuth?: boolean;
    headers?: Record<string, string>;
    method: RequestMethod;
    query?: unknown;
    route: `/${string}`;
    useAuth?: boolean;
}

Type Parameters

  • B = unknown

Hierarchy (View Summary)

Properties

authPrefix? body? enforceAuth? headers? method query? route useAuth?

Properties

OptionalauthPrefix

authPrefix?: string

The authorization prefix to use for this request.

Optionalbody

body?: B

The body to send in this request.

OptionalenforceAuth

enforceAuth?: boolean

If this request requires the Authorization token.

Optionalheaders

headers?: Record<string, string>

Additional headers to add to this request.

method

method: RequestMethod

HTTP method to use.

Optionalquery

query?: unknown

The URL query parameters to be sent with the request

route

route: `/${string}`

Route to request.

OptionaluseAuth

useAuth?: boolean

If this request needs the Authorization header.

Settings

Member Visibility

On This Page

Properties