Skip to content
This repository has been archived by the owner on Oct 13, 2020. It is now read-only.

Latest commit

 

History

History
48 lines (37 loc) · 3.23 KB

README.md

File metadata and controls

48 lines (37 loc) · 3.23 KB

NPM info

NPM version NPM downloads Dependencies Build Status

Quality Gate Maintainability Rating Reliability Rating Security Rating

Test Coverage Bug Count Vulnerabilities Code Smells

Simple NodeJS API to get data from thebluealliance

Note: All methods return Promises, so if you do not know what they are, read this article before continuing

Usage

Installation

npm install tba-api-storm

Intialization

The constructor takes in the data needed for the X-TBA-App-Id header, which is needed for the API requests (For more info on thebluealliance RESTful API, see this)

Method Overview

Dcoumentation and method calls for API v3 is in the form of docstrings for now.

Notes

Anyone who upgrades from version 1.0.6 to a newer version, please look at the method signatures for some have changed