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

@onemedia/national-rail-data-module

v1.2.1

Published

Fetches and translates data from the TFL Unified API.

Downloads

3

Readme

National Rail Data Module

Fetches and translates data from the National Rail LDBWS API.


const Client = require('@onemedia/national-rail-data-module');
const apiClient = new Client({ apiUrl: process.env.API_URL, apiKey: process.env.API_KEY });

const departures = await apiClient.fetchDepartures({ station, filter, rows, timeOffset, timeWindow });

Table of Contents

Requirements

Paddington requires the following to run:

  • [Node.js][node] 8+
  • [npm][npm] (normally comes with Node.js)

Usage

national-rail-data-module is installed via [npm][npm]:

npm install @onemedia/national-rail-data-module

Then you can load the relevant module into your code with a require call:

var Client = require('@onemedia/national-rail-data-module');

The client is required to be instantiated with the API URL and the API_KEY. A timeout value in ms can also be passed in (although defaults to 10000).


const Client = require('@onemedia/national-rail-data-module');
const apiClient =  new Client({ apiUrl: process.env.API_URL, apiKey: process.env.API_KEY });

Client

apiClient.fetchDepartures({ station: 'OXF'})

Retrieves departure board information for specified station.