node-nfl-api

1.0.3 • Public • Published

Node NFL API

A simple module for asychnronously fetching the current week's NFL data.

Installation

You will need to include node-nfl-api in your project

npm i node-nfl-api --save

Basic example

var nflapi = require('node-nfl-api');

nflapi.fetch().subscribe(
    x => {
        console.log("Received: ", x);
    },
    e => {
        console.log("Error: ", e);
    },
    () => {
        console.log('done');
    }
);

Options

When fetching NFL data, you may pass an options object as a parameter. This object is optional, as are all of its properties. Below is the structure of the options object.

var options = {
    concurrent: 1, // Number of simultaneous network requests to allow. Default is 1.
    filters: {
        in_progress: true, // Only fetch games which are currently in progress. Default is false.
        include: ['BUF', 'NYJ', 'MIA', 'NE'] // Only fetch games involving a team in the provided array
    }
}

Change Log

1.0.3

  • Implement options filtering (in_progress, include)

Built With

Authors

  • Jay Fialkowski

License

This project is free to use.

Dependencies (3)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i node-nfl-api

    Weekly Downloads

    0

    Version

    1.0.3

    License

    ISC

    Last publish

    Collaborators

    • jayfialkowski