Skip to content

Documentation


Documentation / @blizzard-api/wow-forever / <internal> / Resource

Type Alias: Resource<Response, SearchOptions, IsProtectedResource> ​

Resource<Response, SearchOptions, IsProtectedResource> = (IsProtectedResource extends true ? object : unknown) & object

Defined in: core/src/resource.ts:30

Represents a resource that can be requested from the Blizzard API

Type Parameters ​

Response ​

Response

SearchOptions ​

SearchOptions extends object = Record<string, unknown>

The search options that can be passed to the resource

IsProtectedResource ​

IsProtectedResource extends boolean = false

Type Declaration ​

_responseType? ​

optional _responseType?: Response

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: SearchOptions

path ​

path: string

The request path. Dynamic path segments should be encoded with encodeURIComponent.

Param ​

_Response

The response type of the resource

Param ​

ProtectedResource

Whether the resource requires a token to be requested