Documentation / @blizzard-api/wow / <internal> / Resource
Type Alias: Resource<Response, SearchOptions, IsProtectedResource>
Resource<
Response,SearchOptions,IsProtectedResource> = (IsProtectedResourceextendstrue?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?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?: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