Documentation
    Preparing search index...

    Module @blizzard-api/core - v2.1.1

    @blizzard-api/core

    This package provides core functionality to the other @blizzard-api/* packages.

    npm i @blizzard-api/core
    

    The package includes a series of types that define values that are allowed to be passed to Battle.net API.

    import type { BlizzardNamespaces, Locales, Origins } from '@blizzard-api/core';
    

    It also includes a helper function to get the origin, hostname and locale easily accessible based off a single origin.

    import type { getBlizzardApi } from '@blizzard-api/core';

    const { origin, hostname, locale } = getBlizzardApi('eu'); // "kr" | "tw" | "us"

    Interfaces

    BaseSearchParameters
    SearchResponse

    Type Aliases

    BlizzardNamespaces
    ExtractResourceType
    Locales
    Origins
    ProtectedResource
    Resource
    ResourceResponse

    Functions

    getBlizzardApi