mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-23 23:29:35 +02:00
16 lines
615 B
Markdown
16 lines
615 B
Markdown
|
# Profiles
|
||
|
|
|
||
|
|
This directory contains specific customisations for each endpoint, called *profiles*. They **parse data from the API differently, add additional information, or enable non-default methods** (such as [`journeyLeg`](../docs/journey-leg.md)) if they are supported.
|
||
|
|
|
||
|
|
Each profile has it's own directory. It will be passed into `hafas-client` and is expected to be in a certain structure:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const createClient = require('hafas-client')
|
||
|
|
const someProfile = require('hafas-client/p/some-profile')
|
||
|
|
|
||
|
|
// create a client with the profile
|
||
|
|
const client = createClient(dbProfile)
|
||
|
|
|
||
|
|
// use it to query data…
|
||
|
|
```
|