Interface GetParameters

Parameters for getting a resource.

Remarks

This interface defines the parameters required for getting a resource.

interface GetParameters {
    headers?: OutgoingHttpHeaders;
    path?: Record<string, any>;
    query?: Record<string, any>;
    signal?: AbortSignal;
    url: string;
}

Properties

headers? path? query? signal? url

Properties

Optional headers

headers?: OutgoingHttpHeaders

Optional headers for the request.

Optional path

path?: Record<string, any>

Optional path parameters for the request.

Optional query

query?: Record<string, any>

Optional query parameters for the request.

Optional signal

signal?: AbortSignal

Optional abort signal for the request.

url

url: string

The URL of the resource to get.

Settings

Member Visibility

Theme

On This Page

headerspathquerysignalurl