npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@blizzard-api/wow

v2.0.0

Published

A series of helpers to interact with the World of Warcraft Blizzard API

Downloads

157

Readme

@blizzard-api/wow

This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for World of Warcraft.

Installation

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

Usage

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

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

const achievement = wow.achievement(123);
        ^ { path: string, namespace?: string, parameters?: Record<string, never> }

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

import { achievement } from "@blizzard-api/wow"

const achi = achievement(123);
        ^ { path: string, namespace?: string, parameters?: Record<string, never> }

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 { AchievementResponse } from '@blizzard-api/wow';

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

import type { ExtractResourceType } from "@blizzard-api/core";
import { wow } from "@blizzard-api/wow"

const achievement = wow.achievement(123);
        ^ { path: string, namespace?: string, parameters?: Record<string, never> }

type AchievementResponse = ExtractResourceType<typeof achievement>;

Differences to @blizzard-api/classic-wow

This package is specifically for World of Warcraft (retail or modern), and as such, the endpoints and responses are different from the classic variants. If you are looking for the classic version of World of Warcraft, you should use @blizzard-api/classic-wow instead.

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 { 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.data);
                      ^ typeof AuctionHouseCommoditiesResponse