GithubHelp home page GithubHelp logo

2729stormrobotics / tba-api-storm Goto Github PK

View Code? Open in Web Editor NEW
8.0 10.0 4.0 719 KB

Promised based NodeJS API for interacting with thebluealliance

License: MIT License

JavaScript 100.00%
nodejs node-js thebluealliance frc first-robotics-competition first-frc first-robotics

tba-api-storm's Introduction

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

tba-api-storm's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar mcao avatar rjbohinski avatar tomorth avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

rjbohinski tomorth rakusan2 pchild

tba-api-storm's Issues

More thorough testing

test.js only tests one function.

  • All functions within tba-storm.js should be tested.
  • Check the HTTP response code.
  • Check the accuracy of the contents if possible. Some functions like getTeamEventList(teamNum) will fail depending on the year.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.