Type Alias Resource<Response, SearchOptions, IsProtectedResource>

Resource: (IsProtectedResource extends true ? { token: string } : unknown) & {
    _responseType?: Response;
    namespace?: BlizzardNamespaces;
    parameters?: SearchOptions;
    path: string;
}

Represents a resource that can be requested from the Blizzard API

Type Parameters

Response
SearchOptions extends object = Record<string, unknown>
The search options that can be passed to the resource
IsProtectedResource extends boolean = false

Type Declaration

Optional Internal_responseType?: Response
The response type of the resource
Optionalnamespace?: BlizzardNamespaces
Optionalparameters?: SearchOptions
path: string

Param: _Response

The response type of the resource

Param: ProtectedResource

Whether the resource requires a token to be requested