planner.js

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #llm #machine-learning #linux #macos #java #kubernetes #awesome-list #security #ios #open-source

(★ 40)

JavaScript library for route planning 🚴‍♂️🚉🚀

planner.js Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Planner.js: A JS library for route planning

🛸️ [![Build Status](https://travis-ci.org/openplannerteam/planner.js.svg?branch=dev)](https://travis-ci.org/openplannerteam/planner.js) 🚴 [![MIT License](https://img.shields.io/github/license/openplannerteam/planner.js.svg?maxAge=2592000)](https://github.com/openplannerteam/planner.js/blob/master/LICENSE) 🚉  [![npm version](https://badge.fury.io/js/plannerjs.svg)](https://badge.fury.io/js/plannerjs) 🚀

```
$ npm install plannerjs
```

Include it in the browser:
```html
<script src="https://planner.js.org/js/planner-latest.js"></script>

...

Include it in your JavaScript project:
```javascript
const { FlexibleTransitPlanner, Units } = require('plannerjs');

// or

import { FlexibleTransitPlanner, Units } from 'plannerjs';
```

Use it in both environments:
```javascript
const planner = new FlexibleTransitPlanner();
planner.addConnectionSource("https://graph.irail.be/sncb/connections");
planner.addStopSource("https://irail.be/stations/NMBS");

planner.query({
  from: "http://irail.be/stations/NMBS/008812005", // Brussels North
  to: "http://irail.be/stations/NMBS/008892007", // Ghent-Sint-Pieters
  minimumDepartureTime: new Date(),
  
  walkingSpeed: 3, // KmH
  minimumWalkingSpeed: 3, // KmH
 
  maximumWalkingDistance: 200, // meters
  
  minimumTransferDuration: Units.fromMinutes(1),
  maximumTransferDuration: Units.fromMinutes(30),
  
  maximumTravelDuration: Units.fromHours(1.5),
  
  maximumTransfers: 4,
})
  .take(3)
  .on('data', (path) => {
   console.log(JSON.stringify(path, null, 4));
  })
  .on('end', () => {
    console.log('No more paths!')
  })
  .on('error', (error) => {
    console.error(error);
  });
```

## Documentation

For further instructions, follow the documentation at https://planner.js.org/

## Developing

* Building the docs with typedoc: `npm run doc`
 * Testing with jest: `npm test`
 * Build a new browser version with `npm run browser`
 * Bundle the latest planner for the docs example `npm run doc-bundle`

planner.js

planner.js Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

planner.js

planner.js Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README