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

metlink-api-http-client

v1.0.2

Published

HTTP Client for Metlink Wellington API

Downloads

3

Readme

Metlink API HTTP Client (Wellington, New Zealand)

https://opendata.metlink.org.nz/

Quality Gate Status code style: prettier Build status

Install

--

How to use

Example

Look

example.ts

Host

https://api.opendata.metlink.org.nz/v1

Init

Client

import { MetlinkHttpClientInterface } from './Contracts'
import { MetlinkHttpClientBuilder } from './MetlinkHttpClientBuilder'

const options = {
    timeout: 1000,
}
const metlinkHttpClient: MetlinkHttpClientInterface =
    MetlinkHttpClientBuilder.buildWithAxios(
        token,
        options,
        function (axios: AxiosInstance) {
            axios.interceptors.response.use(
                function (response) {
                    return response
                },
                function (error) {
                    return Promise.reject(error)
                }
            )
        }
    )

OR

import { MetlinkHttpClientInterface } from './Contracts'
import { MetlinkHttpClientBuilder } from './MetlinkHttpClientBuilder'

const options = {
    timeout: 1000,
}
const metlinkHttpClient: MetlinkHttpClientInterface =
    MetlinkHttpClientBuilder.buildWithAxiosAndDecorate(
        token,
        options,
        function (axios: AxiosInstance) {
            axios.interceptors.response.use(
                function (response) {
                    return response
                },
                function (error) {
                    return Promise.reject(error)
                }
            )
        }
    )

Wrapped response body

const metlinkHttpClient = new ResponseDataDecorator(httpClient)

Tests

Config with env

.jest/setEnvVars

Use

TOKEN_FILE=.token jest tests

Unresolved issues:

  • GTFS-RT: Service Alerts: Validation Scheme issue
  • GTFS-RT: Trip Updates: Validation Scheme issue

API

GTFS

Agencies

Transit agencies with service represented in this dataset.

metlinkHttpClient.getGtfsAgencies()

Calendars

Service dates specified using a weekly schedule with start and end dates.

metlinkHttpClient.getGtfsCalendar()

Calendar Dates

Exceptions for the services defined in the calendar.

metlinkHttpClient.getGtfsCalendarDates()

Feed info

Dataset metadata, including publisher, version, and expiration information.

metlinkHttpClient.getGtfsFeedInfo()

Routes

Transit routes. A route is a group of trips that are displayed to riders as a single service.

metlinkHttpClient.getGtfsRoutes()

Shapes

Rules for mapping vehicle travel paths, sometimes referred to as route alignments.

metlinkHttpClient.getGtfsShapes('shapeId')

Stop Times

Times that a vehicle arrives at and departs from stops for each trip.

metlinkHttpClient.getGtfsStopTimes('tripId')

Stops

Stops where vehicles pick up or drop off riders. Also defines stations and station entrances.

metlinkHttpClient.getGtfsStops()

Transfers

Rules for making connections at transfer points between routes.

metlinkHttpClient.getGtfsTransfers()

Trips

Trips for each route. A trip is a sequence of two or more stops that occur during a specific time period.

metlinkHttpClient.getGtfsTrips(
    'start',
    'extraFields',
    'routeId',
    'tripId',
    'end'
)

GTFS-RT

Service Alerts

Information about unforeseen events affecting routes, stops, or the network. Use accept header 'application/x-protobuf' to receive in Protobuf format.

metlinkHttpClient.getGtfsServiceAlerts()

Trip Updates

Delays, cancellations, changed routes. Use accept header 'application/x-protobuf' to receive in Protobuf format.

metlinkHttpClient.getGtfsRtTripUpdates()

Vehicle Positions

Information about vehicles including location. Use accept header 'application/x-protobuf' to receive in Protobuf format.

metlinkHttpClient.getGtfsRtVehiclePositions()

Other

Stop Departure Predictions

Predictions for when vehicles will arrive and depart through stops.

metlinkHttpClient.getStopPredictions('stopId')

Trip Cancellations

Historical, current, and known future data for trip cancellations.

const query: Query = new Query()
query.dateCreated = Date.now().toString()
metlinkHttpClient.getTripCancellation(query)