Skip to content

Documentation


Documentation / @blizzard-api/hs / getDeck

Function: getDeck() ​

getDeck(options): object

Defined in: hs/src/decks/index.ts:9

Returns a deck based on the code provided.

Parameters ​

options ​

{ code: string; } | { hero?: string | number; ids: (string | number)[]; sideboardCards?: `${number}:${number}` | `${number}:${number}`[]; }

The options for fetching a deck.

Returns ​

The deck resource. See DeckResponse.

_responseType? ​

optional _responseType?: DeckResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: DeckSearchParameters

path ​

path: string

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