Interface RequestOptions<B, Q>

Represents the data that will be sent to the endpoint.

interface RequestOptions<B = unknown, Q = unknown> {
    authPrefix?: string;
    body?: B;
    enforceAuth?: boolean;
    headers?: Record<string, string>;
    query?: Q;
    useAuth?: boolean;
}

Type Parameters

  • B = unknown
  • Q = unknown

Hierarchy (View Summary)

Properties

authPrefix? body? enforceAuth? headers? query? 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.

Optionalquery

query?: Q

The URL query parameters to be sent with the request

OptionaluseAuth

useAuth?: boolean

If this request needs the Authorization header.

Settings

Member Visibility

On This Page

Properties