node-artifact-api
A node module wrapper for the Valve official Artifact API
Last updated 8 months ago by ammuench .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install node-artifact-api 
SYNC missed versions from official npm registry.

Node Artifact Api Build Status npm version Open Issues

This is a node wrapper for the official Valve Artifact API, with Typescript support

Installation

Install with NPM

npm i --save node-artifact-api

import singular methods, or full api as object

import { decodeDeck, encodeDeck, getSet } from 'node-artifact-api';

// OR

import * as ArtifactApi from 'node-artifact-api';

then use any of the methods below.

Project written in Typescript and has types support out of the box.

Features

  • Fetching card set by ID
  • Fetching cards by ID
  • In-memory caching
  • Decoding deck codes
  • Encoding decks into deck codes

More is coming soon, especially once the Beta is released on the 19th and I can play with the client directly for more test data.

For a full API Documentation, click here

Feature Roadmap

The following is a list of features planned for release with this API in the coming weeks:

  • Individual Card Fetching (Done in v0.3.0!)
  • System for passing a "caching" middleware (In Progress)
    • In memory caching completed with v0.3.0!
  • Deck Decoding (Done in v0.2.0!)
  • Deck Encoding (Done in v0.4.0! (thank you to artbarte for your work!)

Caching

As of v0.3.0 the getCard and getSet methods cache in-memory according to Valve's API Guidelines:

After receiving the response, you must then request the JSON file from the host specified. In this example, "https://some host/some path/somefile.json". Please cache the provided JSON for AT LEAST until the expire time provided.

By default the above methods will use this caching rule. Cache can be cleared with an optional parameter provided to each method. It is not advised to clear caches outside of the API rules unless you are having issues or are handling caching separately, in order to avoid being blocked from accessing the API.

Contributors

Feel free to open a PR or log an issue if you would work on this repo.

Thank you to the following people for contributing so far!

Current Tags

  • 0.2.1-beta                                ...           beta (8 months ago)
  • 0.4.2                                ...           latest (8 months ago)

9 Versions

  • 0.4.2                                ...           8 months ago
  • 0.4.1                                ...           8 months ago
  • 0.4.0                                ...           8 months ago
  • 0.3.0                                ...           8 months ago
  • 0.2.1                                ...           8 months ago
  • 0.2.1-beta                                ...           8 months ago
  • 0.2.0                                ...           8 months ago
  • 0.1.1                                ...           8 months ago
  • 0.1.0                                ...           8 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 9
Dependencies (4)
Dev Dependencies (14)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |