Skip to content

MonsieurMan/navitia-query-builder

Repository files navigation

Build Status Coverage Status

Navitia Query Builder

This packace is an attempt at creating a better experience to query navitia APIs from javascript and typescript.

Disclaimer

This package is currently a WIP and the API won't be stable until 1.0

// Current API
const departures = new NavitiaUrlBuilder()
            .endpoint('https://test-endpoint.fr')
            .v1()
            .coverage('sncf')
            .stopArea('OCE:SA:87713040')
            .departure()
            .count(5)
            .parseUrl();
// https://test-endpoint.fr/v1/coverage/sncf/stop_areas/stop_area:OCE:SA:87713040/departures?count=5&
 

TODO

  • Beta npm
  • Make library fully immutable
  • ? Minify package
  • Extract jest config from package.json
  • Travis
  • Coveralls
  • Vscode test with F5
  • Full params for departure
  • Extract parameters (count, depth, ...) into their own generic class
  • Minimal doc
  • ? Add types

About

Fluently build Navitia query URLs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published