@blizzard-api/hs v1.0.0

@blizzard-api/hs

This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for Diablo 3.

Installation

npm i @blizzard-api/core @blizzard-api/hs

Usage

You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the hs export.

import { hs } from "@blizzard-api/hs"
//or
import hs from "@blizzard-api/hs"

const season = hs.allMetadata(123);
        ^ Resource<AllMetadataResponse>

If you don't want to use the exported hs object, you can also access the functions directly:

import { allMetadata } from "@blizzard-api/hs"

const seasonI = season(123);
        ^ Resource<AllMetadataResponse>

Types

If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:

import type { SeasonResponse } from '@blizzard-api/hs';

If you simply want to use the existing object, you can use the helper, ExtractResourceType, from @blizzard-api/core like so:

import { hs } from "@blizzard-api/hs"

const season = hs.allMetadata();
        ^ Resource<AllMetadataResponse>

type AllMetadataResponse = ExtractResourceType<typeof season>;

Notes on Types

The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely to be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.

Client

While this package is made to function on it's own, it performs even better when combined with @blizzard-api/client where you can easily request data combining the two libraries.

import { createBlizzardApiClient } from '@blizzard-api/client';
import { hs } from '@blizzard-api/hs';

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(hs.allMetadata());

console.log(response.data);
                      ^ typeof AllMetadataResponse