Documentation
    Preparing search index...

    Module @blizzard-api/client - v2.2.2

    @blizzard-api/client

    This package provides a client that is meant to be used together with one or more of the packages dedicated to a blizzard game.

    Currently available packages are:

    • @blizzard-api/classic-wow
    • @blizzard-api/d3
    • @blizzard-api/hs
    • @blizzard-api/sc2
    • @blizzard-api/wow
    npm i @blizzard-api/client
    
    import { createBlizzardApiClient } from '@blizzard-api/client';
    //or
    import createBlizzardApiClient from '@blizzard-api/client';
    import { wow } from '@blizzard-api/wow';

    const client = await createBlizzardApiClient({
    key: 'environment.blizzardClientId',
    secret: 'environment.blizzardClientSecret',
    origin: 'eu',
    });

    //Response will automatically be typed with the appropriate values
    const response = await client.sendRequest(wow.commodities());

    console.log(response);
    ^ typeof AuctionHouseCommoditiesResponse

    Please refer to the battle.net documentation for guides on how to obtain Blizzard API credentials.

    Interfaces

    AccessToken
    AccessTokenRequestArguments
    ClientOptions
    ValidateAccessTokenArguments
    ValidateAccessTokenResponse

    Type Aliases

    AxiosCompatability

    Functions

    createBlizzardApiClient

    References

    default → createBlizzardApiClient