https://github.com/derhuerst/vbb-stations-autocomplete

Search for stations in the Berlin Brandenburg public transport service (VBB).
https://github.com/derhuerst/vbb-stations-autocomplete

berlin bvg transit transport vbb

Last synced: 1 day ago
JSON representation

Search for stations in the Berlin Brandenburg public transport service (VBB).

• Host: GitHub
• URL: https://github.com/derhuerst/vbb-stations-autocomplete
• Owner: derhuerst
• License: isc
• Created: 2015-08-10T15:31:19.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-29T12:47:57.000Z (8 months ago)
• Last Synced: 2024-09-10T14:58:59.897Z (23 days ago)
• Topics: berlin, bvg, transit, transport, vbb
• Language: JavaScript
• Homepage: https://github.com/derhuerst/vbb-stations-autocomplete
• Size: 408 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# vbb-stations-autocomplete

*vbb-stations-autocomplete* provides a **stations search for the Berlin Brandenburg public transport service (VBB)**. It pulls its data from [`vbb-stations`](https://github.com/derhuerst/vbb-stations).

*Note*: Because there are ~ `13k` stations, this module contains ~ `800k` of data (~ `240k` gzipped).

[![npm version](https://img.shields.io/npm/v/vbb-stations-autocomplete.svg)](https://www.npmjs.com/package/vbb-stations-autocomplete)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/vbb-stations-autocomplete.svg)

[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)

[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

## Installing

```shell

npm install vbb-stations-autocomplete

```

## Usage

```js

autocomplete(query, results = 3, fuzzy = false, completion = true)

```

```javascript

const autocomplete = require('vbb-stations-autocomplete')

autocomplete('Seestr', 3)

```

This returns stations in a reduced form of the [*Friendly Public Transport Format*](https://github.com/public-transport/friendly-public-transport-format). To get all details, pass each `id` into [`vbb-stations`](https://github.com/derhuerst/vbb-stations).

```javascript

[

	{

		id: '900000009103', // U Seestr.

		relevance: 2.0817557,

		score: 40.8276194

	}, {

		id: '900000009105', // Seestr./Amrumer Str.

		relevance: 1.0408778,

		score: 15.7013362

	}, {

		id: '900000019103', // Seestr./Beusselstr.

		relevance: 1.3878371,

		score: 12.3226614

	}

]

```

If you set `fuzzy` to `true`, words with a [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) `<= 3` will be taken into account. This is a lot slower though:

test | performance

-----|------------

non-fuzzy – `U mehringdamm` | 325 ops/sec

fuzzy – `U mehrigndamm` | 73 ops/sec

Setting `completion` to `false` speeds things up a lot:

test | performance

-----|------------

completion – `U friedr` | 306 ops/sec

no completion – `U friedr` | 5076 ops/sec

## Contributing

If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/vbb-stations-autocomplete/issues).