From d7885b88dbaaeb784685d40e98f7a04a736505c7 Mon Sep 17 00:00:00 2001 From: Alexis <61119747+Alexis06030631@users.noreply.github.com> Date: Fri, 3 May 2024 18:34:37 +0200 Subject: [PATCH] Update doc --- docs-src/.vitepress/config.js | 1 + docs-src/api/index.md | 23 +- docs-src/api/sncf.js.activeperiods.md | 63 +- ...f.js.administrativeregion._constructor_.md | 48 +- docs-src/api/sncf.js.administrativeregion.md | 157 ++++- docs-src/api/sncf.js.arrival._constructor_.md | 48 +- docs-src/api/sncf.js.arrival.md | 217 ++++++- .../api/sncf.js.baseclient._constructor_.md | 35 +- docs-src/api/sncf.js.baseclient.md | 33 +- docs-src/api/sncf.js.cachedmanager.md | 33 +- .../api/sncf.js.calendar._constructor_.md | 48 +- docs-src/api/sncf.js.calendar.md | 97 ++- docs-src/api/sncf.js.client._constructor_.md | 35 +- docs-src/api/sncf.js.client.login.md | 35 +- docs-src/api/sncf.js.client.md | 272 ++++++++- docs-src/api/sncf.js.client.searchmanager.md | 13 + docs-src/api/sncf.js.co2emission.md | 59 +- docs-src/api/sncf.js.coord.md | 63 +- docs-src/api/sncf.js.createenum.md | 33 +- docs-src/api/sncf.js.datetonavitiadate.md | 35 +- docs-src/api/sncf.js.datewithdateandhour.md | 63 ++ docs-src/api/sncf.js.definerequesterror.md | 33 +- .../api/sncf.js.departure._constructor_.md | 48 +- docs-src/api/sncf.js.departure.md | 217 ++++++- .../api/sncf.js.disruption._constructor_.md | 48 +- docs-src/api/sncf.js.disruption.md | 277 ++++++++- ...sncf.js.disruptionmanager._constructor_.md | 33 +- docs-src/api/sncf.js.disruptionmanager.get.md | 35 +- docs-src/api/sncf.js.disruptionmanager.md | 82 ++- .../api/sncf.js.disruptionmanager.search.md | 52 +- docs-src/api/sncf.js.extractdateintripid.md | 49 ++ docs-src/api/sncf.js.hournativiatohour.md | 52 +- .../api/sncf.js.impactedstop._constructor_.md | 48 +- docs-src/api/sncf.js.impactedstop.md | 157 ++++- docs-src/api/sncf.js.isvalidid.md | 35 +- docs-src/api/sncf.js.isvalidlineid.md | 35 +- docs-src/api/sncf.js.journey._constructor_.md | 48 +- docs-src/api/sncf.js.journey.md | 259 +++++++- .../sncf.js.journeymanager._constructor_.md | 33 +- docs-src/api/sncf.js.journeymanager.get.md | 69 ++- docs-src/api/sncf.js.journeymanager.md | 67 ++- docs-src/api/sncf.js.line._constructor_.md | 48 +- docs-src/api/sncf.js.line.md | 217 ++++++- .../api/sncf.js.linemanager._constructor_.md | 33 +- docs-src/api/sncf.js.linemanager.get.md | 35 +- docs-src/api/sncf.js.linemanager.md | 82 ++- docs-src/api/sncf.js.linemanager.search.md | 35 +- docs-src/api/sncf.js.md | 556 ++++++++++++++++-- docs-src/api/sncf.js.navitiadatetodate.md | 35 +- docs-src/api/sncf.js.network.md | 63 +- docs-src/api/sncf.js.placemanagerresult.md | 77 ++- .../sncf.js.placesmanager._constructor_.md | 33 +- docs-src/api/sncf.js.placesmanager.get.md | 35 +- docs-src/api/sncf.js.placesmanager.md | 82 ++- docs-src/api/sncf.js.placesmanager.search.md | 35 +- docs-src/api/sncf.js.price.md | 63 +- .../sncf.js.requestmanager._constructor_.md | 33 +- .../api/sncf.js.requestmanager.encodeurl.md | 52 +- docs-src/api/sncf.js.requestmanager.md | 161 ++++- .../api/sncf.js.requestmanager.request.md | 52 +- docs-src/api/sncf.js.route._constructor_.md | 48 +- docs-src/api/sncf.js.route.md | 177 +++++- .../sncf.js.searchmanager._constructor_.md | 47 ++ docs-src/api/sncf.js.searchmanager.md | 80 +++ .../api/sncf.js.searchmanager.searchtrain.md | 78 +++ docs-src/api/sncf.js.severity.md | 77 ++- docs-src/api/sncf.js.step._constructor_.md | 48 +- docs-src/api/sncf.js.step.md | 255 +++++++- .../api/sncf.js.stoparea._constructor_.md | 48 +- .../sncf.js.stoparea.administrative_region.md | 2 +- docs-src/api/sncf.js.stoparea.arrivals.md | 35 +- docs-src/api/sncf.js.stoparea.departures.md | 35 +- docs-src/api/sncf.js.stoparea.journeys.md | 52 +- docs-src/api/sncf.js.stoparea.md | 266 ++++++++- .../api/sncf.js.stoparea.vehicle_journeys.md | 53 +- .../api/sncf.js.stopstep._constructor_.md | 48 +- docs-src/api/sncf.js.stopstep.md | 117 +++- .../api/sncf.js.stoptime._constructor_.md | 66 ++- docs-src/api/sncf.js.stoptime.arrival_date.md | 13 + docs-src/api/sncf.js.stoptime.arrival_time.md | 5 + .../api/sncf.js.stoptime.departure_date.md | 13 + .../api/sncf.js.stoptime.departure_time.md | 5 + docs-src/api/sncf.js.stoptime.md | 235 +++++++- docs-src/api/sncf.js.structuresmanager.md | 365 +++++++++++- docs-src/api/sncf.js.time.md | 63 +- docs-src/api/sncf.js.timeimpact.md | 83 ++- docs-src/api/sncf.js.traininfo.md | 123 +++- docs-src/api/sncf.js.vehicle._constructor_.md | 48 +- docs-src/api/sncf.js.vehicle.arrival_date.md | 13 + docs-src/api/sncf.js.vehicle.arrival_time.md | 5 + .../api/sncf.js.vehicle.departure_date.md | 13 + .../api/sncf.js.vehicle.departure_time.md | 5 + docs-src/api/sncf.js.vehicle.md | 317 +++++++++- docs-src/api/sncf.js.weekpattern.md | 149 ++++- 94 files changed, 7283 insertions(+), 519 deletions(-) create mode 100644 docs-src/api/sncf.js.client.searchmanager.md create mode 100644 docs-src/api/sncf.js.datewithdateandhour.md create mode 100644 docs-src/api/sncf.js.extractdateintripid.md create mode 100644 docs-src/api/sncf.js.searchmanager._constructor_.md create mode 100644 docs-src/api/sncf.js.searchmanager.md create mode 100644 docs-src/api/sncf.js.searchmanager.searchtrain.md create mode 100644 docs-src/api/sncf.js.stoptime.arrival_date.md create mode 100644 docs-src/api/sncf.js.stoptime.departure_date.md create mode 100644 docs-src/api/sncf.js.vehicle.arrival_date.md create mode 100644 docs-src/api/sncf.js.vehicle.departure_date.md diff --git a/docs-src/.vitepress/config.js b/docs-src/.vitepress/config.js index 9a7353df..86471514 100644 --- a/docs-src/.vitepress/config.js +++ b/docs-src/.vitepress/config.js @@ -27,6 +27,7 @@ export default { { text: 'Managers', items: [ + { text: 'SearchManager', link: '/api/sncf.js.searchmanager.html' }, { text: 'DisruptionManager', link: '/api/sncf.js.disruptionmanager.html' }, { text: 'JourneyManager', link: '/api/sncf.js.journeymanager.html' }, { text: 'LineManager', link: '/api/sncf.js.linemanager.html' }, diff --git a/docs-src/api/index.md b/docs-src/api/index.md index bb50aaf8..be507bda 100644 --- a/docs-src/api/index.md +++ b/docs-src/api/index.md @@ -6,7 +6,24 @@ ## Packages -| Package | Description | -| --- | --- | -| [sncf.js](./sncf.js.md) | | + + +
+Package + + + + +Description + + +
+ +[sncf.js](./sncf.js.md) + + + + + +
diff --git a/docs-src/api/sncf.js.activeperiods.md b/docs-src/api/sncf.js.activeperiods.md index c31d85be..1640cd0e 100644 --- a/docs-src/api/sncf.js.activeperiods.md +++ b/docs-src/api/sncf.js.activeperiods.md @@ -12,8 +12,63 @@ export interface ActivePeriods ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [end\_date](./sncf.js.activeperiods.end_date.md) | | Date | The end date of the active period | -| [start\_date](./sncf.js.activeperiods.start_date.md) | | Date | The start date of the active period | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[end\_date](./sncf.js.activeperiods.end_date.md) + + + + + + + +Date + + + + +The end date of the active period + + +
+ +[start\_date](./sncf.js.activeperiods.start_date.md) + + + + + + + +Date + + + + +The start date of the active period + + +
diff --git a/docs-src/api/sncf.js.administrativeregion._constructor_.md b/docs-src/api/sncf.js.administrativeregion._constructor_.md index 4b2327b2..bf05010c 100644 --- a/docs-src/api/sncf.js.administrativeregion._constructor_.md +++ b/docs-src/api/sncf.js.administrativeregion._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.administrativeregion.md b/docs-src/api/sncf.js.administrativeregion.md index c9020e89..6a5b69aa 100644 --- a/docs-src/api/sncf.js.administrativeregion.md +++ b/docs-src/api/sncf.js.administrativeregion.md @@ -12,17 +12,154 @@ export declare class AdministrativeRegion ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.administrativeregion._constructor_.md) | | Constructs a new instance of the AdministrativeRegion class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.administrativeregion._constructor_.md) + + + + + + + +Constructs a new instance of the `AdministrativeRegion` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [coord](./sncf.js.administrativeregion.coord.md) | | [Coord](./sncf.js.coord.md) | Return the coordinate of the stop area | -| [id](./sncf.js.administrativeregion.id.md) | | string | Return the stop area id | -| [insee](./sncf.js.administrativeregion.insee.md) | | string | Return the stop area zip code | -| [name](./sncf.js.administrativeregion.name.md) | | string | Return the stop area name | -| [timezone](./sncf.js.administrativeregion.timezone.md) | | number | Return the stop area level | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[coord](./sncf.js.administrativeregion.coord.md) + + + + + + + +[Coord](./sncf.js.coord.md) + + + + +Return the coordinate of the stop area + + +
+ +[id](./sncf.js.administrativeregion.id.md) + + + + + + + +string + + + + +Return the stop area id + + +
+ +[insee](./sncf.js.administrativeregion.insee.md) + + + + + + + +string + + + + +Return the stop area zip code + + +
+ +[name](./sncf.js.administrativeregion.name.md) + + + + + + + +string + + + + +Return the stop area name + + +
+ +[timezone](./sncf.js.administrativeregion.timezone.md) + + + + + + + +number + + + + +Return the stop area level + +
diff --git a/docs-src/api/sncf.js.arrival._constructor_.md b/docs-src/api/sncf.js.arrival._constructor_.md index b98b9c11..3338c14c 100644 --- a/docs-src/api/sncf.js.arrival._constructor_.md +++ b/docs-src/api/sncf.js.arrival._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.arrival.md b/docs-src/api/sncf.js.arrival.md index 20debbf3..983c0060 100644 --- a/docs-src/api/sncf.js.arrival.md +++ b/docs-src/api/sncf.js.arrival.md @@ -12,20 +12,211 @@ export declare class Arrival ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.arrival._constructor_.md) | | Constructs a new instance of the Arrival class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.arrival._constructor_.md) + + + + + + + +Constructs a new instance of the `Arrival` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_date\_time](./sncf.js.arrival.arrival_date_time.md) | | Date | Return the arrival time (real time) | -| [base\_arrival\_date\_time](./sncf.js.arrival.base_arrival_date_time.md) | | Date | Return the arrival time (scheduled) | -| [base\_departure\_date\_time](./sncf.js.arrival.base_departure_date_time.md) | | Date | Return the departure time (scheduled) | -| [departure\_date\_time](./sncf.js.arrival.departure_date_time.md) | | Date | Return the departure time (real time) | -| [isLate](./sncf.js.arrival.islate.md) | | boolean | Return true if the train is late | -| [route](./sncf.js.arrival.route.md) | | [Route](./sncf.js.route.md) | Return the route of the train | -| [stop\_area](./sncf.js.arrival.stop_area.md) | | [StopArea](./sncf.js.stoparea.md) | Return the stop area of the train | -| [train](./sncf.js.arrival.train.md) | | [TrainInfo](./sncf.js.traininfo.md) | Return the train data | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date\_time](./sncf.js.arrival.arrival_date_time.md) + + + + + + + +Date + + + + +Return the arrival time (real time) + + +
+ +[base\_arrival\_date\_time](./sncf.js.arrival.base_arrival_date_time.md) + + + + + + + +Date + + + + +Return the arrival time (scheduled) + + +
+ +[base\_departure\_date\_time](./sncf.js.arrival.base_departure_date_time.md) + + + + + + + +Date + + + + +Return the departure time (scheduled) + + +
+ +[departure\_date\_time](./sncf.js.arrival.departure_date_time.md) + + + + + + + +Date + + + + +Return the departure time (real time) + + +
+ +[isLate](./sncf.js.arrival.islate.md) + + + + + + + +boolean + + + + +Return true if the train is late + + +
+ +[route](./sncf.js.arrival.route.md) + + + + + + + +[Route](./sncf.js.route.md) + + + + +Return the route of the train + + +
+ +[stop\_area](./sncf.js.arrival.stop_area.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the stop area of the train + + +
+ +[train](./sncf.js.arrival.train.md) + + + + + + + +[TrainInfo](./sncf.js.traininfo.md) + + + + +Return the train data + +
diff --git a/docs-src/api/sncf.js.baseclient._constructor_.md b/docs-src/api/sncf.js.baseclient._constructor_.md index fc8b0b3e..3b58bd7b 100644 --- a/docs-src/api/sncf.js.baseclient._constructor_.md +++ b/docs-src/api/sncf.js.baseclient._constructor_.md @@ -14,7 +14,36 @@ constructor(options?: {}); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| options | {} | _(Optional)_ | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +{} + + + + +_(Optional)_ + + +
diff --git a/docs-src/api/sncf.js.baseclient.md b/docs-src/api/sncf.js.baseclient.md index f4f3f288..a15a8528 100644 --- a/docs-src/api/sncf.js.baseclient.md +++ b/docs-src/api/sncf.js.baseclient.md @@ -12,7 +12,34 @@ export declare class BaseClient ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./sncf.js.baseclient._constructor_.md) | | Constructs a new instance of the BaseClient class | + + +
+Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(options)](./sncf.js.baseclient._constructor_.md) + + + + + + + +Constructs a new instance of the `BaseClient` class + + +
diff --git a/docs-src/api/sncf.js.cachedmanager.md b/docs-src/api/sncf.js.cachedmanager.md index 22453ca5..b5889390 100644 --- a/docs-src/api/sncf.js.cachedmanager.md +++ b/docs-src/api/sncf.js.cachedmanager.md @@ -14,7 +14,34 @@ export declare class CachedManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)()](./sncf.js.cachedmanager._constructor_.md) | | Constructs a new instance of the CachedManager class | + + +
+Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)()](./sncf.js.cachedmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `CachedManager` class + + +
diff --git a/docs-src/api/sncf.js.calendar._constructor_.md b/docs-src/api/sncf.js.calendar._constructor_.md index 5d69aadf..49c4b756 100644 --- a/docs-src/api/sncf.js.calendar._constructor_.md +++ b/docs-src/api/sncf.js.calendar._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.calendar.md b/docs-src/api/sncf.js.calendar.md index 530e2ca7..d4c66cbd 100644 --- a/docs-src/api/sncf.js.calendar.md +++ b/docs-src/api/sncf.js.calendar.md @@ -12,14 +12,97 @@ export declare class Calendar ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.calendar._constructor_.md) | | Constructs a new instance of the Calendar class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.calendar._constructor_.md) + + + + + + + +Constructs a new instance of the `Calendar` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [active\_periods](./sncf.js.calendar.active_periods.md) | | [ActivePeriods](./sncf.js.activeperiods.md) | Return the active\_periods of the calendar | -| [week\_pattern](./sncf.js.calendar.week_pattern.md) | | [WeekPattern](./sncf.js.weekpattern.md) | Return the week pattern of the calendar | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[active\_periods](./sncf.js.calendar.active_periods.md) + + + + + + + +[ActivePeriods](./sncf.js.activeperiods.md) + + + + +Return the active\_periods of the calendar + + +
+ +[week\_pattern](./sncf.js.calendar.week_pattern.md) + + + + + + + +[WeekPattern](./sncf.js.weekpattern.md) + + + + +Return the week pattern of the calendar + +
diff --git a/docs-src/api/sncf.js.client._constructor_.md b/docs-src/api/sncf.js.client._constructor_.md index 7e41e21c..97487b04 100644 --- a/docs-src/api/sncf.js.client._constructor_.md +++ b/docs-src/api/sncf.js.client._constructor_.md @@ -14,7 +14,36 @@ constructor(options?: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| options | any | _(Optional)_ | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +any + + + + +_(Optional)_ + + +
diff --git a/docs-src/api/sncf.js.client.login.md b/docs-src/api/sncf.js.client.login.md index ea6fdaf4..1bc2b00d 100644 --- a/docs-src/api/sncf.js.client.login.md +++ b/docs-src/api/sncf.js.client.login.md @@ -14,10 +14,39 @@ login(token?: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| token | string | _(Optional)_ the token of the account to log in with | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +token + + + + +string + + + + +_(Optional)_ the token of the account to log in with + + +
**Returns:** Promise<[Client](./sncf.js.client.md)> diff --git a/docs-src/api/sncf.js.client.md b/docs-src/api/sncf.js.client.md index 61fcc745..fed187be 100644 --- a/docs-src/api/sncf.js.client.md +++ b/docs-src/api/sncf.js.client.md @@ -15,26 +15,266 @@ export declare class Client extends BaseClient ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./sncf.js.client._constructor_.md) | | Constructs a new instance of the Client class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(options)](./sncf.js.client._constructor_.md) + + + + + + + +Constructs a new instance of the `Client` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [debug](./sncf.js.client.debug.md) | | boolean | If app run as debug mode | -| [disruption](./sncf.js.client.disruption.md) | | [DisruptionManager](./sncf.js.disruptionmanager.md) | DisruptionManager class | -| [isReady](./sncf.js.client.isready.md) | readonly | boolean | Indicates whether the client is ready to start working. | -| [journey](./sncf.js.client.journey.md) | | [JourneyManager](./sncf.js.journeymanager.md) | JourneysManager class | -| [line](./sncf.js.client.line.md) | | [LineManager](./sncf.js.linemanager.md) | LineManager class | -| [place](./sncf.js.client.place.md) | | [PlacesManager](./sncf.js.placesmanager.md) | PlacesManager class | -| [requestManager](./sncf.js.client.requestmanager.md) | | [RequestManager](./sncf.js.requestmanager.md) | The request manager of the client | -| [status](./sncf.js.client.status.md) | | string | The status of the client | + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[debug](./sncf.js.client.debug.md) + + + + + + + +boolean + + + + +If app run as debug mode + + +
+ +[disruption](./sncf.js.client.disruption.md) + + + + + + + +[DisruptionManager](./sncf.js.disruptionmanager.md) + + + + +DisruptionManager class + + +
+ +[isReady](./sncf.js.client.isready.md) + + + + +`readonly` + + + + +boolean + + + + +Indicates whether the client is ready to start working. + + +
+ +[journey](./sncf.js.client.journey.md) + + + + + + + +[JourneyManager](./sncf.js.journeymanager.md) + + + + +JourneysManager class + + +
+ +[line](./sncf.js.client.line.md) + + + + + + + +[LineManager](./sncf.js.linemanager.md) + + + + +LineManager class + + +
+ +[place](./sncf.js.client.place.md) + + + + + + + +[PlacesManager](./sncf.js.placesmanager.md) + + + + +PlacesManager class + + +
+ +[requestManager](./sncf.js.client.requestmanager.md) + + + + + + + +[RequestManager](./sncf.js.requestmanager.md) + + + + +The request manager of the client + + +
+ +[searchManager](./sncf.js.client.searchmanager.md) + + + + + + + +[SearchManager](./sncf.js.searchmanager.md) + + + + +SearchManager: It is used to search for a train by headsign ID and other search queries + + +
+ +[status](./sncf.js.client.status.md) + + + + + + + +string + + + + +The status of the client + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [login(token)](./sncf.js.client.login.md) | | Logs the client in, establishing a connection to navitia. | + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[login(token)](./sncf.js.client.login.md) + + + + + + + +Logs the client in, establishing a connection to navitia. + +
diff --git a/docs-src/api/sncf.js.client.searchmanager.md b/docs-src/api/sncf.js.client.searchmanager.md new file mode 100644 index 00000000..1abbfc36 --- /dev/null +++ b/docs-src/api/sncf.js.client.searchmanager.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [Client](./sncf.js.client.md) > [searchManager](./sncf.js.client.searchmanager.md) + +## Client.searchManager property + +SearchManager: It is used to search for a train by headsign ID and other search queries + +**Signature:** + +```typescript +searchManager: SearchManager; +``` diff --git a/docs-src/api/sncf.js.co2emission.md b/docs-src/api/sncf.js.co2emission.md index 51416af9..382bea0f 100644 --- a/docs-src/api/sncf.js.co2emission.md +++ b/docs-src/api/sncf.js.co2emission.md @@ -12,8 +12,59 @@ export interface Co2Emission ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [unit](./sncf.js.co2emission.unit.md) | | string | | -| [value](./sncf.js.co2emission.value.md) | | number | | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[unit](./sncf.js.co2emission.unit.md) + + + + + + + +string + + + + + +
+ +[value](./sncf.js.co2emission.value.md) + + + + + + + +number + + + + + +
diff --git a/docs-src/api/sncf.js.coord.md b/docs-src/api/sncf.js.coord.md index fbf4a459..6b7ac510 100644 --- a/docs-src/api/sncf.js.coord.md +++ b/docs-src/api/sncf.js.coord.md @@ -12,8 +12,63 @@ export interface Coord ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [lat](./sncf.js.coord.lat.md) | | number | Latitude | -| [lon](./sncf.js.coord.lon.md) | | number | Longitude | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[lat](./sncf.js.coord.lat.md) + + + + + + + +number + + + + +Latitude + + +
+ +[lon](./sncf.js.coord.lon.md) + + + + + + + +number + + + + +Longitude + + +
diff --git a/docs-src/api/sncf.js.createenum.md b/docs-src/api/sncf.js.createenum.md index 0c3974b0..0c84d5e1 100644 --- a/docs-src/api/sncf.js.createenum.md +++ b/docs-src/api/sncf.js.createenum.md @@ -12,10 +12,37 @@ export declare function createEnum(keys: any): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| keys | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +keys + + + + +any + + + + + +
**Returns:** any diff --git a/docs-src/api/sncf.js.datetonavitiadate.md b/docs-src/api/sncf.js.datetonavitiadate.md index 61d52974..d016552a 100644 --- a/docs-src/api/sncf.js.datetonavitiadate.md +++ b/docs-src/api/sncf.js.datetonavitiadate.md @@ -14,10 +14,39 @@ export declare function dateToNavitiaDate(date: Date | string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| date | Date \| string | The date to transform | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +date + + + + +Date \| string + + + + +The date to transform + + +
**Returns:** string diff --git a/docs-src/api/sncf.js.datewithdateandhour.md b/docs-src/api/sncf.js.datewithdateandhour.md new file mode 100644 index 00000000..a6071609 --- /dev/null +++ b/docs-src/api/sncf.js.datewithdateandhour.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [dateWithDateAndHour](./sncf.js.datewithdateandhour.md) + +## dateWithDateAndHour() function + +**Signature:** + +```typescript +export declare function dateWithDateAndHour(hour: string, date: Date): Date; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +hour + + + + +string + + + + + +
+ +date + + + + +Date + + + + + +
+**Returns:** + +Date + diff --git a/docs-src/api/sncf.js.definerequesterror.md b/docs-src/api/sncf.js.definerequesterror.md index 533e1d06..120d3913 100644 --- a/docs-src/api/sncf.js.definerequesterror.md +++ b/docs-src/api/sncf.js.definerequesterror.md @@ -15,10 +15,37 @@ export declare function defineRequestError(response: any): { ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| response | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +response + + + + +any + + + + + +
**Returns:** { \[x: string\]: any; readonly name: string; } diff --git a/docs-src/api/sncf.js.departure._constructor_.md b/docs-src/api/sncf.js.departure._constructor_.md index 122db518..c41ac88c 100644 --- a/docs-src/api/sncf.js.departure._constructor_.md +++ b/docs-src/api/sncf.js.departure._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.departure.md b/docs-src/api/sncf.js.departure.md index 2275f567..3bc4fcb3 100644 --- a/docs-src/api/sncf.js.departure.md +++ b/docs-src/api/sncf.js.departure.md @@ -12,20 +12,211 @@ export declare class Departure ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.departure._constructor_.md) | | Constructs a new instance of the Departure class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.departure._constructor_.md) + + + + + + + +Constructs a new instance of the `Departure` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_date\_time](./sncf.js.departure.arrival_date_time.md) | | Date | Return the arrival time (real time) | -| [base\_arrival\_date\_time](./sncf.js.departure.base_arrival_date_time.md) | | Date | Return the arrival time (scheduled) | -| [base\_departure\_date\_time](./sncf.js.departure.base_departure_date_time.md) | | Date | Return the departure time (scheduled) | -| [departure\_date\_time](./sncf.js.departure.departure_date_time.md) | | Date | Return the departure time (real time) | -| [isLate](./sncf.js.departure.islate.md) | | boolean | Return true if the train is late | -| [route](./sncf.js.departure.route.md) | | [Route](./sncf.js.route.md) | Return the route of the train | -| [stop\_area](./sncf.js.departure.stop_area.md) | | [StopArea](./sncf.js.stoparea.md) | Return the stop area of the train | -| [train](./sncf.js.departure.train.md) | | [TrainInfo](./sncf.js.traininfo.md) | Return the train data | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date\_time](./sncf.js.departure.arrival_date_time.md) + + + + + + + +Date + + + + +Return the arrival time (real time) + + +
+ +[base\_arrival\_date\_time](./sncf.js.departure.base_arrival_date_time.md) + + + + + + + +Date + + + + +Return the arrival time (scheduled) + + +
+ +[base\_departure\_date\_time](./sncf.js.departure.base_departure_date_time.md) + + + + + + + +Date + + + + +Return the departure time (scheduled) + + +
+ +[departure\_date\_time](./sncf.js.departure.departure_date_time.md) + + + + + + + +Date + + + + +Return the departure time (real time) + + +
+ +[isLate](./sncf.js.departure.islate.md) + + + + + + + +boolean + + + + +Return true if the train is late + + +
+ +[route](./sncf.js.departure.route.md) + + + + + + + +[Route](./sncf.js.route.md) + + + + +Return the route of the train + + +
+ +[stop\_area](./sncf.js.departure.stop_area.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the stop area of the train + + +
+ +[train](./sncf.js.departure.train.md) + + + + + + + +[TrainInfo](./sncf.js.traininfo.md) + + + + +Return the train data + +
diff --git a/docs-src/api/sncf.js.disruption._constructor_.md b/docs-src/api/sncf.js.disruption._constructor_.md index 369740a3..60d98b9a 100644 --- a/docs-src/api/sncf.js.disruption._constructor_.md +++ b/docs-src/api/sncf.js.disruption._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.disruption.md b/docs-src/api/sncf.js.disruption.md index b067fb76..653a1bda 100644 --- a/docs-src/api/sncf.js.disruption.md +++ b/docs-src/api/sncf.js.disruption.md @@ -12,23 +12,268 @@ export declare class Disruption ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.disruption._constructor_.md) | | Constructs a new instance of the Disruption class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.disruption._constructor_.md) + + + + + + + +Constructs a new instance of the `Disruption` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [canceled](./sncf.js.disruption.canceled.md) | | boolean | Return true if the train was canceled | -| [cause](./sncf.js.disruption.cause.md) | | string | Return the cause of the disruption | -| [delayed](./sncf.js.disruption.delayed.md) | | boolean | Return true if the train was delayed | -| [end](./sncf.js.disruption.end.md) | | Date | Return the end date of the disruption | -| [id](./sncf.js.disruption.id.md) | | string | Return the id of the disruption | -| [impacted\_stops](./sncf.js.disruption.impacted_stops.md) | | [ImpactedStop](./sncf.js.impactedstop.md)\[\] | Return the impacted stops of the disruption | -| [messages](./sncf.js.disruption.messages.md) | | string\[\] | Return the messages of the disruption | -| [severity](./sncf.js.disruption.severity.md) | | [Severity](./sncf.js.severity.md) | Return the severity of the disruption | -| [start](./sncf.js.disruption.start.md) | | Date | Return the start date of the disruption | -| [status](./sncf.js.disruption.status.md) | | string | Return the status of the disruption | -| [updated\_at](./sncf.js.disruption.updated_at.md) | | Date | Return the updated date of the disruption | + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[canceled](./sncf.js.disruption.canceled.md) + + + + + + + +boolean + + + + +Return true if the train was canceled + + +
+ +[cause](./sncf.js.disruption.cause.md) + + + + + + + +string + + + + +Return the cause of the disruption + + +
+ +[delayed](./sncf.js.disruption.delayed.md) + + + + + + + +boolean + + + + +Return true if the train was delayed + + +
+ +[end](./sncf.js.disruption.end.md) + + + + + + + +Date + + + + +Return the end date of the disruption + + +
+ +[id](./sncf.js.disruption.id.md) + + + + + + + +string + + + + +Return the id of the disruption + + +
+ +[impacted\_stops](./sncf.js.disruption.impacted_stops.md) + + + + + + + +[ImpactedStop](./sncf.js.impactedstop.md)\[\] + + + + +Return the impacted stops of the disruption + + +
+ +[messages](./sncf.js.disruption.messages.md) + + + + + + + +string\[\] + + + + +Return the messages of the disruption + + +
+ +[severity](./sncf.js.disruption.severity.md) + + + + + + + +[Severity](./sncf.js.severity.md) + + + + +Return the severity of the disruption + + +
+ +[start](./sncf.js.disruption.start.md) + + + + + + + +Date + + + + +Return the start date of the disruption + + +
+ +[status](./sncf.js.disruption.status.md) + + + + + + + +string + + + + +Return the status of the disruption + + +
+ +[updated\_at](./sncf.js.disruption.updated_at.md) + + + + + + + +Date + + + + +Return the updated date of the disruption + +
diff --git a/docs-src/api/sncf.js.disruptionmanager._constructor_.md b/docs-src/api/sncf.js.disruptionmanager._constructor_.md index 84839451..7e49846e 100644 --- a/docs-src/api/sncf.js.disruptionmanager._constructor_.md +++ b/docs-src/api/sncf.js.disruptionmanager._constructor_.md @@ -14,7 +14,34 @@ constructor(client: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| client | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.disruptionmanager.get.md b/docs-src/api/sncf.js.disruptionmanager.get.md index b5941dd9..44326a09 100644 --- a/docs-src/api/sncf.js.disruptionmanager.get.md +++ b/docs-src/api/sncf.js.disruptionmanager.get.md @@ -14,10 +14,39 @@ get(disruptionID: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| disruptionID | string | The id of the disruption to get | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +disruptionID + + + + +string + + + + +The id of the disruption to get + + +
**Returns:** Promise<[Disruption](./sncf.js.disruption.md)> diff --git a/docs-src/api/sncf.js.disruptionmanager.md b/docs-src/api/sncf.js.disruptionmanager.md index b28ff914..9a286be3 100644 --- a/docs-src/api/sncf.js.disruptionmanager.md +++ b/docs-src/api/sncf.js.disruptionmanager.md @@ -13,14 +13,82 @@ export declare class DisruptionManager extends CachedManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./sncf.js.disruptionmanager._constructor_.md) | | Constructs a new instance of the DisruptionManager class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.disruptionmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `DisruptionManager` class + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(disruptionID)](./sncf.js.disruptionmanager.get.md) | | Get a disruption by id | -| [search(since\_date, until\_date)](./sncf.js.disruptionmanager.search.md) | | Search the disruptions | + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[get(disruptionID)](./sncf.js.disruptionmanager.get.md) + + + + + + + +Get a disruption by id + + +
+ +[search(since\_date, until\_date)](./sncf.js.disruptionmanager.search.md) + + + + + + + +Search the disruptions + +
diff --git a/docs-src/api/sncf.js.disruptionmanager.search.md b/docs-src/api/sncf.js.disruptionmanager.search.md index 57e40422..e4a922d6 100644 --- a/docs-src/api/sncf.js.disruptionmanager.search.md +++ b/docs-src/api/sncf.js.disruptionmanager.search.md @@ -14,11 +14,55 @@ search(since_date?: Date, until_date?: Date): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| since\_date | Date | _(Optional)_ Defines the start date of the disruptions to search for | -| until\_date | Date | _(Optional)_ Defines the end date of the disruptions to search for | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +since\_date + + + + +Date + + + + +_(Optional)_ Defines the start date of the disruptions to search for + + +
+ +until\_date + + + + +Date + + + + +_(Optional)_ Defines the end date of the disruptions to search for + + +
**Returns:** Promise<[Disruption](./sncf.js.disruption.md)\[\]> diff --git a/docs-src/api/sncf.js.extractdateintripid.md b/docs-src/api/sncf.js.extractdateintripid.md new file mode 100644 index 00000000..16b6790b --- /dev/null +++ b/docs-src/api/sncf.js.extractdateintripid.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [extractDateInTripID](./sncf.js.extractdateintripid.md) + +## extractDateInTripID() function + +**Signature:** + +```typescript +export declare function extractDateInTripID(id: string): Date; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +id + + + + +string + + + + + +
+**Returns:** + +Date + diff --git a/docs-src/api/sncf.js.hournativiatohour.md b/docs-src/api/sncf.js.hournativiatohour.md index 0b842514..c0f4f430 100644 --- a/docs-src/api/sncf.js.hournativiatohour.md +++ b/docs-src/api/sncf.js.hournativiatohour.md @@ -14,11 +14,55 @@ export declare function hourNativiaToHour(data: string, PassError?: boolean): st ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| data | string | The navitia date | -| PassError | boolean | _(Optional)_ If true, return null instead of throwing an error | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +data + + + + +string + + + + +The navitia date + + +
+ +PassError + + + + +boolean + + + + +_(Optional)_ If true, return null instead of throwing an error + + +
**Returns:** string diff --git a/docs-src/api/sncf.js.impactedstop._constructor_.md b/docs-src/api/sncf.js.impactedstop._constructor_.md index 2b386eaf..c31ac69c 100644 --- a/docs-src/api/sncf.js.impactedstop._constructor_.md +++ b/docs-src/api/sncf.js.impactedstop._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.impactedstop.md b/docs-src/api/sncf.js.impactedstop.md index 962d4f51..436236d7 100644 --- a/docs-src/api/sncf.js.impactedstop.md +++ b/docs-src/api/sncf.js.impactedstop.md @@ -12,17 +12,154 @@ export declare class ImpactedStop ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.impactedstop._constructor_.md) | | Constructs a new instance of the ImpactedStop class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.impactedstop._constructor_.md) + + + + + + + +Constructs a new instance of the `ImpactedStop` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival](./sncf.js.impactedstop.arrival.md) | | [TimeImpact](./sncf.js.timeimpact.md) | Return the Arrival data of the stop | -| [cause](./sncf.js.impactedstop.cause.md) | | string | Return the cause of the impact | -| [departure](./sncf.js.impactedstop.departure.md) | | [TimeImpact](./sncf.js.timeimpact.md) | Return the Departure data of the stop | -| [is\_detour](./sncf.js.impactedstop.is_detour.md) | | boolean | Return boolean if the stop is impacted by a detour | -| [stop\_area](./sncf.js.impactedstop.stop_area.md) | | [StopArea](./sncf.js.stoparea.md) | Return the stop area | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival](./sncf.js.impactedstop.arrival.md) + + + + + + + +[TimeImpact](./sncf.js.timeimpact.md) + + + + +Return the Arrival data of the stop + + +
+ +[cause](./sncf.js.impactedstop.cause.md) + + + + + + + +string + + + + +Return the cause of the impact + + +
+ +[departure](./sncf.js.impactedstop.departure.md) + + + + + + + +[TimeImpact](./sncf.js.timeimpact.md) + + + + +Return the Departure data of the stop + + +
+ +[is\_detour](./sncf.js.impactedstop.is_detour.md) + + + + + + + +boolean + + + + +Return boolean if the stop is impacted by a detour + + +
+ +[stop\_area](./sncf.js.impactedstop.stop_area.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the stop area + +
diff --git a/docs-src/api/sncf.js.isvalidid.md b/docs-src/api/sncf.js.isvalidid.md index 064b5662..8cf5286a 100644 --- a/docs-src/api/sncf.js.isvalidid.md +++ b/docs-src/api/sncf.js.isvalidid.md @@ -14,10 +14,39 @@ export declare function isValidID(string: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| string | string | The string to check | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +string + + + + +string + + + + +The string to check + + +
**Returns:** boolean diff --git a/docs-src/api/sncf.js.isvalidlineid.md b/docs-src/api/sncf.js.isvalidlineid.md index bc7319dd..c3636be9 100644 --- a/docs-src/api/sncf.js.isvalidlineid.md +++ b/docs-src/api/sncf.js.isvalidlineid.md @@ -14,10 +14,39 @@ export declare function isValidLineID(string: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| string | string | The string to check | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +string + + + + +string + + + + +The string to check + + +
**Returns:** boolean diff --git a/docs-src/api/sncf.js.journey._constructor_.md b/docs-src/api/sncf.js.journey._constructor_.md index 74668736..73a4f127 100644 --- a/docs-src/api/sncf.js.journey._constructor_.md +++ b/docs-src/api/sncf.js.journey._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.journey.md b/docs-src/api/sncf.js.journey.md index 62d6fc1b..ad226338 100644 --- a/docs-src/api/sncf.js.journey.md +++ b/docs-src/api/sncf.js.journey.md @@ -12,22 +12,251 @@ export declare class Journey ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.journey._constructor_.md) | | Constructs a new instance of the Journey class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.journey._constructor_.md) + + + + + + + +Constructs a new instance of the `Journey` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_date\_time](./sncf.js.journey.arrival_date_time.md) | | Date | Arrival time | -| [departure\_date\_time](./sncf.js.journey.departure_date_time.md) | | Date | Departure time | -| [disruptions](./sncf.js.journey.disruptions.md) | | [Disruption](./sncf.js.disruption.md)\[\] | If the journey has disruptions return the disruptions | -| [duration](./sncf.js.journey.duration.md) | | number | Duration of the journey | -| [id](./sncf.js.journey.id.md) | | string | Return the journey id | -| [price](./sncf.js.journey.price.md) | | [Price](./sncf.js.price.md) | Price of the journey | -| [status](./sncf.js.journey.status.md) | | string | Return value if status is define | -| [steps](./sncf.js.journey.steps.md) | readonly | [Step](./sncf.js.step.md)\[\] | Get the steps of the journey | -| [transfers](./sncf.js.journey.transfers.md) | | number | Transfers of the journey | -| [type](./sncf.js.journey.type.md) | | string | Define the journey average | + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date\_time](./sncf.js.journey.arrival_date_time.md) + + + + + + + +Date + + + + +Arrival time + + +
+ +[departure\_date\_time](./sncf.js.journey.departure_date_time.md) + + + + + + + +Date + + + + +Departure time + + +
+ +[disruptions](./sncf.js.journey.disruptions.md) + + + + + + + +[Disruption](./sncf.js.disruption.md)\[\] + + + + +If the journey has disruptions return the disruptions + + +
+ +[duration](./sncf.js.journey.duration.md) + + + + + + + +number + + + + +Duration of the journey + + +
+ +[id](./sncf.js.journey.id.md) + + + + + + + +string + + + + +Return the journey id + + +
+ +[price](./sncf.js.journey.price.md) + + + + + + + +[Price](./sncf.js.price.md) + + + + +Price of the journey + + +
+ +[status](./sncf.js.journey.status.md) + + + + + + + +string + + + + +Return value if status is define + + +
+ +[steps](./sncf.js.journey.steps.md) + + + + +`readonly` + + + + +[Step](./sncf.js.step.md)\[\] + + + + +Get the steps of the journey + + +
+ +[transfers](./sncf.js.journey.transfers.md) + + + + + + + +number + + + + +Transfers of the journey + + +
+ +[type](./sncf.js.journey.type.md) + + + + + + + +string + + + + +Define the journey average + +
diff --git a/docs-src/api/sncf.js.journeymanager._constructor_.md b/docs-src/api/sncf.js.journeymanager._constructor_.md index b72400ec..331bd8ee 100644 --- a/docs-src/api/sncf.js.journeymanager._constructor_.md +++ b/docs-src/api/sncf.js.journeymanager._constructor_.md @@ -14,7 +14,34 @@ constructor(client: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| client | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.journeymanager.get.md b/docs-src/api/sncf.js.journeymanager.get.md index 44c988ba..fc2ef228 100644 --- a/docs-src/api/sncf.js.journeymanager.get.md +++ b/docs-src/api/sncf.js.journeymanager.get.md @@ -14,12 +14,71 @@ get(from: string, to: string, date?: Date): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| from | string | The departure stop area id or name | -| to | string | The arrival stop area id or name | -| date | Date | _(Optional)_ The date of the journey to get | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +from + + + + +string + + + + +The departure stop area id or name + + +
+ +to + + + + +string + + + + +The arrival stop area id or name + + +
+ +date + + + + +Date + + + + +_(Optional)_ The date of the journey to get + + +
**Returns:** Promise<[Journey](./sncf.js.journey.md)> diff --git a/docs-src/api/sncf.js.journeymanager.md b/docs-src/api/sncf.js.journeymanager.md index 4cdb1699..470facfa 100644 --- a/docs-src/api/sncf.js.journeymanager.md +++ b/docs-src/api/sncf.js.journeymanager.md @@ -13,13 +13,68 @@ export declare class JourneyManager extends CachedManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./sncf.js.journeymanager._constructor_.md) | | Constructs a new instance of the JourneyManager class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.journeymanager._constructor_.md) + + + + + + + +Constructs a new instance of the `JourneyManager` class + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(from, to, date)](./sncf.js.journeymanager.get.md) | | Get a journey details with departure and arrival stop areas ids | + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[get(from, to, date)](./sncf.js.journeymanager.get.md) + + + + + + + +Get a journey details with departure and arrival stop areas ids + +
diff --git a/docs-src/api/sncf.js.line._constructor_.md b/docs-src/api/sncf.js.line._constructor_.md index 54da7ce7..78f45cde 100644 --- a/docs-src/api/sncf.js.line._constructor_.md +++ b/docs-src/api/sncf.js.line._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.line.md b/docs-src/api/sncf.js.line.md index ae46548e..ec28f530 100644 --- a/docs-src/api/sncf.js.line.md +++ b/docs-src/api/sncf.js.line.md @@ -12,20 +12,211 @@ export declare class Line ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.line._constructor_.md) | | Constructs a new instance of the Line class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.line._constructor_.md) + + + + + + + +Constructs a new instance of the `Line` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [closing\_time](./sncf.js.line.closing_time.md) | | string | Return the closing time (HH:MM:SS) | -| [commercial\_mode](./sncf.js.line.commercial_mode.md) | | string | Return the commercial mode | -| [id](./sncf.js.line.id.md) | | string | Return the line id | -| [name](./sncf.js.line.name.md) | | string | Return the line name | -| [network](./sncf.js.line.network.md) | | [Network](./sncf.js.network.md) | Return the line network | -| [opening\_time](./sncf.js.line.opening_time.md) | | string | Return the opening time (HH:MM:SS) | -| [physical\_modes](./sncf.js.line.physical_modes.md) | | [Network](./sncf.js.network.md)\[\] | Return the physical modes | -| [routes](./sncf.js.line.routes.md) | | [Route](./sncf.js.route.md)\[\] | Return the line routes if exist | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[closing\_time](./sncf.js.line.closing_time.md) + + + + + + + +string + + + + +Return the closing time (HH:MM:SS) + + +
+ +[commercial\_mode](./sncf.js.line.commercial_mode.md) + + + + + + + +string + + + + +Return the commercial mode + + +
+ +[id](./sncf.js.line.id.md) + + + + + + + +string + + + + +Return the line id + + +
+ +[name](./sncf.js.line.name.md) + + + + + + + +string + + + + +Return the line name + + +
+ +[network](./sncf.js.line.network.md) + + + + + + + +[Network](./sncf.js.network.md) + + + + +Return the line network + + +
+ +[opening\_time](./sncf.js.line.opening_time.md) + + + + + + + +string + + + + +Return the opening time (HH:MM:SS) + + +
+ +[physical\_modes](./sncf.js.line.physical_modes.md) + + + + + + + +[Network](./sncf.js.network.md)\[\] + + + + +Return the physical modes + + +
+ +[routes](./sncf.js.line.routes.md) + + + + + + + +[Route](./sncf.js.route.md)\[\] + + + + +Return the line routes if exist + +
diff --git a/docs-src/api/sncf.js.linemanager._constructor_.md b/docs-src/api/sncf.js.linemanager._constructor_.md index 32d82985..b8b06fe8 100644 --- a/docs-src/api/sncf.js.linemanager._constructor_.md +++ b/docs-src/api/sncf.js.linemanager._constructor_.md @@ -14,7 +14,34 @@ constructor(client: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| client | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.linemanager.get.md b/docs-src/api/sncf.js.linemanager.get.md index 04529935..5a4a0bfa 100644 --- a/docs-src/api/sncf.js.linemanager.get.md +++ b/docs-src/api/sncf.js.linemanager.get.md @@ -14,10 +14,39 @@ get(lineID: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| lineID | string | The id of the line | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +lineID + + + + +string + + + + +The id of the line + + +
**Returns:** Promise<[Line](./sncf.js.line.md)> diff --git a/docs-src/api/sncf.js.linemanager.md b/docs-src/api/sncf.js.linemanager.md index 4c5f84d7..ea5f0f82 100644 --- a/docs-src/api/sncf.js.linemanager.md +++ b/docs-src/api/sncf.js.linemanager.md @@ -13,14 +13,82 @@ export declare class LineManager extends CachedManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./sncf.js.linemanager._constructor_.md) | | Constructs a new instance of the LineManager class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.linemanager._constructor_.md) + + + + + + + +Constructs a new instance of the `LineManager` class + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(lineID)](./sncf.js.linemanager.get.md) | | Get a line by id | -| [search(line)](./sncf.js.linemanager.search.md) | | Search a line by name (departure - arrival) | + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[get(lineID)](./sncf.js.linemanager.get.md) + + + + + + + +Get a line by id + + +
+ +[search(line)](./sncf.js.linemanager.search.md) + + + + + + + +Search a line by name (departure - arrival) + +
diff --git a/docs-src/api/sncf.js.linemanager.search.md b/docs-src/api/sncf.js.linemanager.search.md index 538cc92d..92cc5847 100644 --- a/docs-src/api/sncf.js.linemanager.search.md +++ b/docs-src/api/sncf.js.linemanager.search.md @@ -14,10 +14,39 @@ search(line: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| line | string | The name of the line | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +line + + + + +string + + + + +The name of the line + + +
**Returns:** Promise<[Line](./sncf.js.line.md)\[\]> diff --git a/docs-src/api/sncf.js.md b/docs-src/api/sncf.js.md index 2d048b4c..dc1ca0bc 100644 --- a/docs-src/api/sncf.js.md +++ b/docs-src/api/sncf.js.md @@ -6,67 +6,515 @@ ## Classes -| Class | Description | -| --- | --- | -| [AdministrativeRegion](./sncf.js.administrativeregion.md) | | -| [Arrival](./sncf.js.arrival.md) | | -| [BaseClient](./sncf.js.baseclient.md) | | -| [CachedManager](./sncf.js.cachedmanager.md) | Manages the API methods of a data model with a mutable cache of instances. | -| [Calendar](./sncf.js.calendar.md) | | -| [Client](./sncf.js.client.md) | The main hub for interacting with the Navitia API. | -| [Departure](./sncf.js.departure.md) | | -| [Disruption](./sncf.js.disruption.md) | | -| [DisruptionManager](./sncf.js.disruptionmanager.md) | | -| [ImpactedStop](./sncf.js.impactedstop.md) | | -| [Journey](./sncf.js.journey.md) | | -| [JourneyManager](./sncf.js.journeymanager.md) | | -| [Line](./sncf.js.line.md) | | -| [LineManager](./sncf.js.linemanager.md) | | -| [PlacesManager](./sncf.js.placesmanager.md) | | -| [RequestManager](./sncf.js.requestmanager.md) | | -| [Route](./sncf.js.route.md) | | -| [Step](./sncf.js.step.md) | | -| [StopArea](./sncf.js.stoparea.md) | | -| [StopStep](./sncf.js.stopstep.md) | | -| [StopTime](./sncf.js.stoptime.md) | | -| [StructuresManager](./sncf.js.structuresmanager.md) | | -| [Vehicle](./sncf.js.vehicle.md) | | + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Class + + + + +Description + + +
+ +[AdministrativeRegion](./sncf.js.administrativeregion.md) + + + + + +
+ +[Arrival](./sncf.js.arrival.md) + + + + + +
+ +[BaseClient](./sncf.js.baseclient.md) + + + + + +
+ +[CachedManager](./sncf.js.cachedmanager.md) + + + + +Manages the API methods of a data model with a mutable cache of instances. + + +
+ +[Calendar](./sncf.js.calendar.md) + + + + + +
+ +[Client](./sncf.js.client.md) + + + + +The main hub for interacting with the Navitia API. + + +
+ +[Departure](./sncf.js.departure.md) + + + + + +
+ +[Disruption](./sncf.js.disruption.md) + + + + + +
+ +[DisruptionManager](./sncf.js.disruptionmanager.md) + + + + + +
+ +[ImpactedStop](./sncf.js.impactedstop.md) + + + + + +
+ +[Journey](./sncf.js.journey.md) + + + + + +
+ +[JourneyManager](./sncf.js.journeymanager.md) + + + + + +
+ +[Line](./sncf.js.line.md) + + + + + +
+ +[LineManager](./sncf.js.linemanager.md) + + + + + +
+ +[PlacesManager](./sncf.js.placesmanager.md) + + + + + +
+ +[RequestManager](./sncf.js.requestmanager.md) + + + + + +
+ +[Route](./sncf.js.route.md) + + + + + +
+ +[SearchManager](./sncf.js.searchmanager.md) + + + + + +
+ +[Step](./sncf.js.step.md) + + + + + +
+ +[StopArea](./sncf.js.stoparea.md) + + + + + +
+ +[StopStep](./sncf.js.stopstep.md) + + + + + +
+ +[StopTime](./sncf.js.stoptime.md) + + + + + +
+ +[StructuresManager](./sncf.js.structuresmanager.md) + + + + + +
+ +[Vehicle](./sncf.js.vehicle.md) + + + + + +
## Functions -| Function | Description | -| --- | --- | -| [createEnum(keys)](./sncf.js.createenum.md) | | -| [dateToNavitiaDate(date)](./sncf.js.datetonavitiadate.md) | Transform a Date object to a navitia date | -| [defineRequestError(response)](./sncf.js.definerequesterror.md) | | -| [hourNativiaToHour(data, PassError)](./sncf.js.hournativiatohour.md) | Transform a navitia date to a moment object (format: HHmmss to HH:mm:ss) | -| [isValidID(string)](./sncf.js.isvalidid.md) | Check if is a valid ID | -| [isValidLineID(string)](./sncf.js.isvalidlineid.md) | Check if is a valid Line ID | -| [navitiaDateToDate(date)](./sncf.js.navitiadatetodate.md) | Transform a navitia date to a Date object | + + + + + + + + + + +
+ +Function + + + + +Description + + +
+ +[createEnum(keys)](./sncf.js.createenum.md) + + + + + +
+ +[dateToNavitiaDate(date)](./sncf.js.datetonavitiadate.md) + + + + +Transform a Date object to a navitia date + + +
+ +[dateWithDateAndHour(hour, date)](./sncf.js.datewithdateandhour.md) + + + + + +
+ +[defineRequestError(response)](./sncf.js.definerequesterror.md) + + + + + +
+ +[extractDateInTripID(id)](./sncf.js.extractdateintripid.md) + + + + + +
+ +[hourNativiaToHour(data, PassError)](./sncf.js.hournativiatohour.md) + + + + +Transform a navitia date to a moment object (format: HHmmss to HH:mm:ss) + + +
+ +[isValidID(string)](./sncf.js.isvalidid.md) + + + + +Check if is a valid ID + + +
+ +[isValidLineID(string)](./sncf.js.isvalidlineid.md) + + + + +Check if is a valid Line ID + + +
+ +[navitiaDateToDate(date)](./sncf.js.navitiadatetodate.md) + + + + +Transform a navitia date to a Date object + + +
## Interfaces -| Interface | Description | -| --- | --- | -| [ActivePeriods](./sncf.js.activeperiods.md) | | -| [Co2Emission](./sncf.js.co2emission.md) | | -| [Coord](./sncf.js.coord.md) | | -| [Network](./sncf.js.network.md) | | -| [PlaceManagerResult](./sncf.js.placemanagerresult.md) | | -| [Price](./sncf.js.price.md) | | -| [Severity](./sncf.js.severity.md) | | -| [Time](./sncf.js.time.md) | | -| [TimeImpact](./sncf.js.timeimpact.md) | | -| [TrainInfo](./sncf.js.traininfo.md) | | -| [WeekPattern](./sncf.js.weekpattern.md) | | + + + + + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[ActivePeriods](./sncf.js.activeperiods.md) + + + + + +
+ +[Co2Emission](./sncf.js.co2emission.md) + + + + + +
+ +[Coord](./sncf.js.coord.md) + + + + + +
+ +[Network](./sncf.js.network.md) + + + + + +
+ +[PlaceManagerResult](./sncf.js.placemanagerresult.md) + + + + + +
+ +[Price](./sncf.js.price.md) + + + + + +
+ +[Severity](./sncf.js.severity.md) + + + + + +
+ +[Time](./sncf.js.time.md) + + + + + +
+ +[TimeImpact](./sncf.js.timeimpact.md) + + + + + +
+ +[TrainInfo](./sncf.js.traininfo.md) + + + + + +
+ +[WeekPattern](./sncf.js.weekpattern.md) + + + + + +
## Variables -| Variable | Description | -| --- | --- | -| [ErrorCodes](./sncf.js.errorcodes.md) | | -| [Messages](./sncf.js.messages.md) | | -| [SncfjsError](./sncf.js.sncfjserror.md) | | -| [SncfjsRangeError](./sncf.js.sncfjsrangeerror.md) | | -| [SncfjsTypeError](./sncf.js.sncfjstypeerror.md) | | + + + + + + +
+ +Variable + + + + +Description + + +
+ +[ErrorCodes](./sncf.js.errorcodes.md) + + + + + +
+ +[Messages](./sncf.js.messages.md) + + + + + +
+ +[SncfjsError](./sncf.js.sncfjserror.md) + + + + + +
+ +[SncfjsRangeError](./sncf.js.sncfjsrangeerror.md) + + + + + +
+ +[SncfjsTypeError](./sncf.js.sncfjstypeerror.md) + + + + +
diff --git a/docs-src/api/sncf.js.navitiadatetodate.md b/docs-src/api/sncf.js.navitiadatetodate.md index ec7a7bea..f2185fb2 100644 --- a/docs-src/api/sncf.js.navitiadatetodate.md +++ b/docs-src/api/sncf.js.navitiadatetodate.md @@ -14,10 +14,39 @@ export declare function navitiaDateToDate(date: string): Date; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| date | string | The navitia date format: YYYYMMDD\[T\]HHmmss | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +date + + + + +string + + + + +The navitia date format: YYYYMMDD\[T\]HHmmss + + +
**Returns:** Date diff --git a/docs-src/api/sncf.js.network.md b/docs-src/api/sncf.js.network.md index dcd29f55..85937ece 100644 --- a/docs-src/api/sncf.js.network.md +++ b/docs-src/api/sncf.js.network.md @@ -12,8 +12,63 @@ export interface Network ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./sncf.js.network.id.md) | | string | The id of the network | -| [name](./sncf.js.network.name.md) | | string | The name of the network | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[id](./sncf.js.network.id.md) + + + + + + + +string + + + + +The id of the network + + +
+ +[name](./sncf.js.network.name.md) + + + + + + + +string + + + + +The name of the network + + +
diff --git a/docs-src/api/sncf.js.placemanagerresult.md b/docs-src/api/sncf.js.placemanagerresult.md index 2cc39861..4d540129 100644 --- a/docs-src/api/sncf.js.placemanagerresult.md +++ b/docs-src/api/sncf.js.placemanagerresult.md @@ -12,9 +12,76 @@ export interface PlaceManagerResult ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [administrative\_regions](./sncf.js.placemanagerresult.administrative_regions.md) | | [AdministrativeRegion](./sncf.js.administrativeregion.md)\[\] | | -| [date](./sncf.js.placemanagerresult.date.md) | | Date | | -| [stop\_areas](./sncf.js.placemanagerresult.stop_areas.md) | | [StopArea](./sncf.js.stoparea.md)\[\] | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[administrative\_regions](./sncf.js.placemanagerresult.administrative_regions.md) + + + + + + + +[AdministrativeRegion](./sncf.js.administrativeregion.md)\[\] + + + + + +
+ +[date](./sncf.js.placemanagerresult.date.md) + + + + + + + +Date + + + + + +
+ +[stop\_areas](./sncf.js.placemanagerresult.stop_areas.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md)\[\] + + + + + +
diff --git a/docs-src/api/sncf.js.placesmanager._constructor_.md b/docs-src/api/sncf.js.placesmanager._constructor_.md index 6339f1d7..157ceed7 100644 --- a/docs-src/api/sncf.js.placesmanager._constructor_.md +++ b/docs-src/api/sncf.js.placesmanager._constructor_.md @@ -14,7 +14,34 @@ constructor(client: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| client | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.placesmanager.get.md b/docs-src/api/sncf.js.placesmanager.get.md index 094a71dd..c9851169 100644 --- a/docs-src/api/sncf.js.placesmanager.get.md +++ b/docs-src/api/sncf.js.placesmanager.get.md @@ -14,10 +14,39 @@ get(stationID: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| stationID | string | The id of the station to get | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +stationID + + + + +string + + + + +The id of the station to get + + +
**Returns:** Promise<[StopArea](./sncf.js.stoparea.md) \| [AdministrativeRegion](./sncf.js.administrativeregion.md)> diff --git a/docs-src/api/sncf.js.placesmanager.md b/docs-src/api/sncf.js.placesmanager.md index 2ef75ce3..33cb6b29 100644 --- a/docs-src/api/sncf.js.placesmanager.md +++ b/docs-src/api/sncf.js.placesmanager.md @@ -13,14 +13,82 @@ export declare class PlacesManager extends CachedManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./sncf.js.placesmanager._constructor_.md) | | Constructs a new instance of the PlacesManager class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.placesmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `PlacesManager` class + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [get(stationID)](./sncf.js.placesmanager.get.md) | | Get a place by id | -| [search(station)](./sncf.js.placesmanager.search.md) | | Search for a place by name | + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[get(stationID)](./sncf.js.placesmanager.get.md) + + + + + + + +Get a place by id + + +
+ +[search(station)](./sncf.js.placesmanager.search.md) + + + + + + + +Search for a place by name + +
diff --git a/docs-src/api/sncf.js.placesmanager.search.md b/docs-src/api/sncf.js.placesmanager.search.md index 5c7be0da..96db14e8 100644 --- a/docs-src/api/sncf.js.placesmanager.search.md +++ b/docs-src/api/sncf.js.placesmanager.search.md @@ -14,10 +14,39 @@ search(station: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| station | string | The name of the station to search for | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +station + + + + +string + + + + +The name of the station to search for + + +
**Returns:** Promise<[PlaceManagerResult](./sncf.js.placemanagerresult.md)> diff --git a/docs-src/api/sncf.js.price.md b/docs-src/api/sncf.js.price.md index dc79bbec..b05fc3d6 100644 --- a/docs-src/api/sncf.js.price.md +++ b/docs-src/api/sncf.js.price.md @@ -12,8 +12,63 @@ export interface Price ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [found](./sncf.js.price.found.md) | | boolean | If the price is found | -| [value](./sncf.js.price.value.md) | | number | The currency of the price | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[found](./sncf.js.price.found.md) + + + + + + + +boolean + + + + +If the price is found + + +
+ +[value](./sncf.js.price.value.md) + + + + + + + +number + + + + +The currency of the price + + +
diff --git a/docs-src/api/sncf.js.requestmanager._constructor_.md b/docs-src/api/sncf.js.requestmanager._constructor_.md index 27c1071a..8624cf06 100644 --- a/docs-src/api/sncf.js.requestmanager._constructor_.md +++ b/docs-src/api/sncf.js.requestmanager._constructor_.md @@ -14,7 +14,34 @@ constructor(client: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| client | any | | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.requestmanager.encodeurl.md b/docs-src/api/sncf.js.requestmanager.encodeurl.md index 475dac82..a3d718e1 100644 --- a/docs-src/api/sncf.js.requestmanager.encodeurl.md +++ b/docs-src/api/sncf.js.requestmanager.encodeurl.md @@ -14,11 +14,55 @@ encodeURL(path?: string, params?: any): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | _(Optional)_ The path to url | -| params | any | _(Optional)_ The parameters to encode | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +path + + + + +string + + + + +_(Optional)_ The path to url + + +
+ +params + + + + +any + + + + +_(Optional)_ The parameters to encode + + +
**Returns:** string diff --git a/docs-src/api/sncf.js.requestmanager.md b/docs-src/api/sncf.js.requestmanager.md index 6d3feadc..3e5fc2cc 100644 --- a/docs-src/api/sncf.js.requestmanager.md +++ b/docs-src/api/sncf.js.requestmanager.md @@ -13,22 +13,159 @@ export declare class RequestManager extends EventEmitter ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(client)](./sncf.js.requestmanager._constructor_.md) | | The client that instantiated this WebSocketManager | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.requestmanager._constructor_.md) + + + + + + + +The client that instantiated this WebSocketManager + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [config](./sncf.js.requestmanager.config.md) | | any | The configuration of the request manager | -| [requestNumber](./sncf.js.requestmanager.requestnumber.md) | | number | The number of the request | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[config](./sncf.js.requestmanager.config.md) + + + + + + + +any + + + + +The configuration of the request manager + + +
+ +[requestNumber](./sncf.js.requestmanager.requestnumber.md) + + + + + + + +number + + + + +The number of the request + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [connect()](./sncf.js.requestmanager.connect.md) | | Try to log in with the token | -| [encodeURL(path, params)](./sncf.js.requestmanager.encodeurl.md) | | Encode the parameters and the url | -| [request(path, params)](./sncf.js.requestmanager.request.md) | | Make a request to the API | + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[connect()](./sncf.js.requestmanager.connect.md) + + + + + + + +Try to log in with the token + + +
+ +[encodeURL(path, params)](./sncf.js.requestmanager.encodeurl.md) + + + + + + + +Encode the parameters and the url + + +
+ +[request(path, params)](./sncf.js.requestmanager.request.md) + + + + + + + +Make a request to the API + +
diff --git a/docs-src/api/sncf.js.requestmanager.request.md b/docs-src/api/sncf.js.requestmanager.request.md index f529707a..6dcd44b5 100644 --- a/docs-src/api/sncf.js.requestmanager.request.md +++ b/docs-src/api/sncf.js.requestmanager.request.md @@ -14,11 +14,55 @@ request(path: string, params?: any): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | The path to url | -| params | any | _(Optional)_ The parameters to encode | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +path + + + + +string + + + + +The path to url + + +
+ +params + + + + +any + + + + +_(Optional)_ The parameters to encode + + +
**Returns:** Promise<any> diff --git a/docs-src/api/sncf.js.route._constructor_.md b/docs-src/api/sncf.js.route._constructor_.md index 1e92410a..bdc8fa8f 100644 --- a/docs-src/api/sncf.js.route._constructor_.md +++ b/docs-src/api/sncf.js.route._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.route.md b/docs-src/api/sncf.js.route.md index 26d9a6e4..0f2e9993 100644 --- a/docs-src/api/sncf.js.route.md +++ b/docs-src/api/sncf.js.route.md @@ -12,18 +12,173 @@ export declare class Route ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.route._constructor_.md) | | Constructs a new instance of the Route class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.route._constructor_.md) + + + + + + + +Constructs a new instance of the `Route` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [direction\_type](./sncf.js.route.direction_type.md) | | string | Return the route direction type | -| [direction](./sncf.js.route.direction.md) | | [StopArea](./sncf.js.stoparea.md) | Return the route direction | -| [id](./sncf.js.route.id.md) | | string | Return the route id | -| [line](./sncf.js.route.line.md) | | [Line](./sncf.js.line.md) | Return the route line | -| [name](./sncf.js.route.name.md) | | string | Return the route name | -| [physical\_modes](./sncf.js.route.physical_modes.md) | | any\[\] | Physical mode of the route | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[direction\_type](./sncf.js.route.direction_type.md) + + + + + + + +string + + + + +Return the route direction type + + +
+ +[direction](./sncf.js.route.direction.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the route direction + + +
+ +[id](./sncf.js.route.id.md) + + + + + + + +string + + + + +Return the route id + + +
+ +[line](./sncf.js.route.line.md) + + + + + + + +[Line](./sncf.js.line.md) + + + + +Return the route line + + +
+ +[name](./sncf.js.route.name.md) + + + + + + + +string + + + + +Return the route name + + +
+ +[physical\_modes](./sncf.js.route.physical_modes.md) + + + + + + + +any\[\] + + + + +Physical mode of the route + +
diff --git a/docs-src/api/sncf.js.searchmanager._constructor_.md b/docs-src/api/sncf.js.searchmanager._constructor_.md new file mode 100644 index 00000000..99225f58 --- /dev/null +++ b/docs-src/api/sncf.js.searchmanager._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [SearchManager](./sncf.js.searchmanager.md) > [(constructor)](./sncf.js.searchmanager._constructor_.md) + +## SearchManager.(constructor) + +Constructs a new instance of the `SearchManager` class + +**Signature:** + +```typescript +constructor(client: any); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +client + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.searchmanager.md b/docs-src/api/sncf.js.searchmanager.md new file mode 100644 index 00000000..4ed1f605 --- /dev/null +++ b/docs-src/api/sncf.js.searchmanager.md @@ -0,0 +1,80 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [SearchManager](./sncf.js.searchmanager.md) + +## SearchManager class + +**Signature:** + +```typescript +export declare class SearchManager extends CachedManager +``` +**Extends:** [CachedManager](./sncf.js.cachedmanager.md) + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(client)](./sncf.js.searchmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `SearchManager` class + + +
+ +## Methods + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[searchTrain(headsign, date)](./sncf.js.searchmanager.searchtrain.md) + + + + + + + +Search a train by headsign ID + + +
diff --git a/docs-src/api/sncf.js.searchmanager.searchtrain.md b/docs-src/api/sncf.js.searchmanager.searchtrain.md new file mode 100644 index 00000000..695b54ab --- /dev/null +++ b/docs-src/api/sncf.js.searchmanager.searchtrain.md @@ -0,0 +1,78 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [SearchManager](./sncf.js.searchmanager.md) > [searchTrain](./sncf.js.searchmanager.searchtrain.md) + +## SearchManager.searchTrain() method + +Search a train by headsign ID + +**Signature:** + +```typescript +searchTrain(headsign: string, date?: Date): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +headsign + + + + +string + + + + +The headsign of the line + + +
+ +date + + + + +Date + + + + +_(Optional)_ Not required, but highly recommended for effective results + + +
+**Returns:** + +Promise<[Vehicle](./sncf.js.vehicle.md)> + +## Example + +This example shows how to search a line by name + +```javascript +const vehicle = await sncf.searchManager.searchTrain('123456', date) +console.log(vehicle) +``` + diff --git a/docs-src/api/sncf.js.severity.md b/docs-src/api/sncf.js.severity.md index cdda48bb..75fd15b1 100644 --- a/docs-src/api/sncf.js.severity.md +++ b/docs-src/api/sncf.js.severity.md @@ -12,9 +12,76 @@ export interface Severity ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [code](./sncf.js.severity.code.md) | | string | | -| [name](./sncf.js.severity.name.md) | | string | | -| [priority](./sncf.js.severity.priority.md) | | string | | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[code](./sncf.js.severity.code.md) + + + + + + + +string + + + + + +
+ +[name](./sncf.js.severity.name.md) + + + + + + + +string + + + + + +
+ +[priority](./sncf.js.severity.priority.md) + + + + + + + +string + + + + + +
diff --git a/docs-src/api/sncf.js.step._constructor_.md b/docs-src/api/sncf.js.step._constructor_.md index bae76a78..cb7d09d3 100644 --- a/docs-src/api/sncf.js.step._constructor_.md +++ b/docs-src/api/sncf.js.step._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.step.md b/docs-src/api/sncf.js.step.md index 1af24ce4..c9b6ea7e 100644 --- a/docs-src/api/sncf.js.step.md +++ b/docs-src/api/sncf.js.step.md @@ -12,22 +12,247 @@ export declare class Step ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.step._constructor_.md) | | Constructs a new instance of the Step class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.step._constructor_.md) + + + + + + + +Constructs a new instance of the `Step` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_date\_time](./sncf.js.step.arrival_date_time.md) | | Date | Return the step arrival date time | -| [co2\_emission](./sncf.js.step.co2_emission.md) | | [Co2Emission](./sncf.js.co2emission.md) | | -| [departure\_date\_time](./sncf.js.step.departure_date_time.md) | | Date | Return the step departure date time | -| [duration](./sncf.js.step.duration.md) | | number | Return the step duration | -| [from](./sncf.js.step.from.md) | | [StopArea](./sncf.js.stoparea.md) | Return the step from if exist | -| [id](./sncf.js.step.id.md) | | string | Return the step id | -| [is\_transfer](./sncf.js.step.is_transfer.md) | | boolean | Return boolean if the step is a transfer | -| [stops](./sncf.js.step.stops.md) | | [StopStep](./sncf.js.stopstep.md)\[\] | Return the step stops if exist | -| [to](./sncf.js.step.to.md) | | [StopArea](./sncf.js.stoparea.md) | Return the step to if exist | -| [type](./sncf.js.step.type.md) | | string | Return the step type | + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date\_time](./sncf.js.step.arrival_date_time.md) + + + + + + + +Date + + + + +Return the step arrival date time + + +
+ +[co2\_emission](./sncf.js.step.co2_emission.md) + + + + + + + +[Co2Emission](./sncf.js.co2emission.md) + + + + + +
+ +[departure\_date\_time](./sncf.js.step.departure_date_time.md) + + + + + + + +Date + + + + +Return the step departure date time + + +
+ +[duration](./sncf.js.step.duration.md) + + + + + + + +number + + + + +Return the step duration + + +
+ +[from](./sncf.js.step.from.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the step from if exist + + +
+ +[id](./sncf.js.step.id.md) + + + + + + + +string + + + + +Return the step id + + +
+ +[is\_transfer](./sncf.js.step.is_transfer.md) + + + + + + + +boolean + + + + +Return boolean if the step is a transfer + + +
+ +[stops](./sncf.js.step.stops.md) + + + + + + + +[StopStep](./sncf.js.stopstep.md)\[\] + + + + +Return the step stops if exist + + +
+ +[to](./sncf.js.step.to.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the step to if exist + + +
+ +[type](./sncf.js.step.type.md) + + + + + + + +string + + + + +Return the step type + +
diff --git a/docs-src/api/sncf.js.stoparea._constructor_.md b/docs-src/api/sncf.js.stoparea._constructor_.md index 6cf0a761..b757f83a 100644 --- a/docs-src/api/sncf.js.stoparea._constructor_.md +++ b/docs-src/api/sncf.js.stoparea._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.stoparea.administrative_region.md b/docs-src/api/sncf.js.stoparea.administrative_region.md index 931683d3..3594c59e 100644 --- a/docs-src/api/sncf.js.stoparea.administrative_region.md +++ b/docs-src/api/sncf.js.stoparea.administrative_region.md @@ -9,5 +9,5 @@ Return the Administative Region of the stop area (if exist) **Signature:** ```typescript -administrative_region: AdministrativeRegion; +administrative_region: AdministrativeRegion | null; ``` diff --git a/docs-src/api/sncf.js.stoparea.arrivals.md b/docs-src/api/sncf.js.stoparea.arrivals.md index 7b8df1e0..f552ad53 100644 --- a/docs-src/api/sncf.js.stoparea.arrivals.md +++ b/docs-src/api/sncf.js.stoparea.arrivals.md @@ -14,10 +14,39 @@ arrivals(date?: Date): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| date | Date | _(Optional)_ The date of the arrivals | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +date + + + + +Date + + + + +_(Optional)_ The date of the arrivals + + +
**Returns:** Promise<[Arrival](./sncf.js.arrival.md)\[\]> diff --git a/docs-src/api/sncf.js.stoparea.departures.md b/docs-src/api/sncf.js.stoparea.departures.md index dc5abed1..b288d5c7 100644 --- a/docs-src/api/sncf.js.stoparea.departures.md +++ b/docs-src/api/sncf.js.stoparea.departures.md @@ -14,10 +14,39 @@ departures(date?: Date): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| date | Date | _(Optional)_ The date of the departures | + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +date + + + + +Date + + + + +_(Optional)_ The date of the departures + + +
**Returns:** Promise<[Departure](./sncf.js.departure.md)\[\]> diff --git a/docs-src/api/sncf.js.stoparea.journeys.md b/docs-src/api/sncf.js.stoparea.journeys.md index 588df064..bd90ba05 100644 --- a/docs-src/api/sncf.js.stoparea.journeys.md +++ b/docs-src/api/sncf.js.stoparea.journeys.md @@ -14,11 +14,55 @@ journeys(to?: string, date?: Date): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| to | string | _(Optional)_ The id or name of the destination | -| date | Date | _(Optional)_ The date of the journey | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +to + + + + +string + + + + +_(Optional)_ The id or name of the destination + + +
+ +date + + + + +Date + + + + +_(Optional)_ The date of the journey + + +
**Returns:** Promise<[Journey](./sncf.js.journey.md)\[\]> diff --git a/docs-src/api/sncf.js.stoparea.md b/docs-src/api/sncf.js.stoparea.md index a4064d79..77ed813e 100644 --- a/docs-src/api/sncf.js.stoparea.md +++ b/docs-src/api/sncf.js.stoparea.md @@ -12,28 +12,258 @@ export declare class StopArea ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.stoparea._constructor_.md) | | Constructs a new instance of the StopArea class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.stoparea._constructor_.md) + + + + + + + +Constructs a new instance of the `StopArea` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [administrative\_region](./sncf.js.stoparea.administrative_region.md) | | [AdministrativeRegion](./sncf.js.administrativeregion.md) | Return the Administative Region of the stop area (if exist) | -| [coord](./sncf.js.stoparea.coord.md) | | [Coord](./sncf.js.coord.md) | The coord of the stop area | -| [id](./sncf.js.stoparea.id.md) | | string | The id of the stop area | -| [name](./sncf.js.stoparea.name.md) | | string | The name of the stop area | -| [timezone](./sncf.js.stoparea.timezone.md) | | string | The timezone of the stop area | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[administrative\_region](./sncf.js.stoparea.administrative_region.md) + + + + + + + +[AdministrativeRegion](./sncf.js.administrativeregion.md) \| null + + + + +Return the Administative Region of the stop area (if exist) + + +
+ +[coord](./sncf.js.stoparea.coord.md) + + + + + + + +[Coord](./sncf.js.coord.md) + + + + +The coord of the stop area + + +
+ +[id](./sncf.js.stoparea.id.md) + + + + + + + +string + + + + +The id of the stop area + + +
+ +[name](./sncf.js.stoparea.name.md) + + + + + + + +string + + + + +The name of the stop area + + +
+ +[timezone](./sncf.js.stoparea.timezone.md) + + + + + + + +string + + + + +The timezone of the stop area + + +
## Methods -| Method | Modifiers | Description | -| --- | --- | --- | -| [arrivals(date)](./sncf.js.stoparea.arrivals.md) | | Get the arrivals of the stop area | -| [departures(date)](./sncf.js.stoparea.departures.md) | | Get the departures of the stop area | -| [journeys(to, date)](./sncf.js.stoparea.journeys.md) | | Get Journeys from the stop area | -| [lines()](./sncf.js.stoparea.lines.md) | | Get the lines of the stop area | -| [routes()](./sncf.js.stoparea.routes.md) | | Get the routes of the stop area | -| [vehicle\_journeys(date)](./sncf.js.stoparea.vehicle_journeys.md) | | Get vehicle journeys of the stop area | + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[arrivals(date)](./sncf.js.stoparea.arrivals.md) + + + + + + + +Get the arrivals of the stop area + + +
+ +[departures(date)](./sncf.js.stoparea.departures.md) + + + + + + + +Get the departures of the stop area + + +
+ +[journeys(to, date)](./sncf.js.stoparea.journeys.md) + + + + + + + +Get Journeys from the stop area + + +
+ +[lines()](./sncf.js.stoparea.lines.md) + + + + + + + +Get the lines of the stop area + + +
+ +[routes()](./sncf.js.stoparea.routes.md) + + + + + + + +Get the routes of the stop area + + +
+ +[vehicle\_journeys(since, until)](./sncf.js.stoparea.vehicle_journeys.md) + + + + + + + +Get vehicle journeys of the stop area + +
diff --git a/docs-src/api/sncf.js.stoparea.vehicle_journeys.md b/docs-src/api/sncf.js.stoparea.vehicle_journeys.md index 52780562..2674ff63 100644 --- a/docs-src/api/sncf.js.stoparea.vehicle_journeys.md +++ b/docs-src/api/sncf.js.stoparea.vehicle_journeys.md @@ -9,15 +9,60 @@ Get vehicle journeys of the stop area **Signature:** ```typescript -vehicle_journeys(date?: Date): Promise; +vehicle_journeys(since?: Date, until?: Date): Promise; ``` ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| date | Date | _(Optional)_ The date of the vehicle journeys | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +since + + + + +Date + + + + +_(Optional)_ The start date of the vehicle journeys to get + + +
+ +until + + + + +Date + + + + +_(Optional)_ The end date of the vehicle journeys to get (default: since + 1 day) + + +
**Returns:** Promise<[Vehicle](./sncf.js.vehicle.md)\[\]> diff --git a/docs-src/api/sncf.js.stopstep._constructor_.md b/docs-src/api/sncf.js.stopstep._constructor_.md index 05f8cbc0..ddffb445 100644 --- a/docs-src/api/sncf.js.stopstep._constructor_.md +++ b/docs-src/api/sncf.js.stopstep._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.stopstep.md b/docs-src/api/sncf.js.stopstep.md index 727d82dc..a9428298 100644 --- a/docs-src/api/sncf.js.stopstep.md +++ b/docs-src/api/sncf.js.stopstep.md @@ -12,15 +12,116 @@ export declare class StopStep ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.stopstep._constructor_.md) | | Constructs a new instance of the StopStep class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.stopstep._constructor_.md) + + + + + + + +Constructs a new instance of the `StopStep` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival](./sncf.js.stopstep.arrival.md) | | [Time](./sncf.js.time.md) | Return the Arrival data of the stop | -| [departure](./sncf.js.stopstep.departure.md) | | [Time](./sncf.js.time.md) | Return the Departure data of the stop | -| [stop\_area](./sncf.js.stopstep.stop_area.md) | | [StopArea](./sncf.js.stoparea.md) | Return the stop area | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival](./sncf.js.stopstep.arrival.md) + + + + + + + +[Time](./sncf.js.time.md) + + + + +Return the Arrival data of the stop + + +
+ +[departure](./sncf.js.stopstep.departure.md) + + + + + + + +[Time](./sncf.js.time.md) + + + + +Return the Departure data of the stop + + +
+ +[stop\_area](./sncf.js.stopstep.stop_area.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the stop area + +
diff --git a/docs-src/api/sncf.js.stoptime._constructor_.md b/docs-src/api/sncf.js.stoptime._constructor_.md index 68c0e843..64a73408 100644 --- a/docs-src/api/sncf.js.stoptime._constructor_.md +++ b/docs-src/api/sncf.js.stoptime._constructor_.md @@ -9,13 +9,69 @@ Constructs a new instance of the `StopTime` class **Signature:** ```typescript -constructor(Client: any, data: any); +constructor(Client: any, data: any, date?: Date); ``` ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
+ +date + + + + +Date + + + + +_(Optional)_ + + +
diff --git a/docs-src/api/sncf.js.stoptime.arrival_date.md b/docs-src/api/sncf.js.stoptime.arrival_date.md new file mode 100644 index 00000000..838e7fd2 --- /dev/null +++ b/docs-src/api/sncf.js.stoptime.arrival_date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [StopTime](./sncf.js.stoptime.md) > [arrival\_date](./sncf.js.stoptime.arrival_date.md) + +## StopTime.arrival\_date property + +Return the arrival date of the train + +**Signature:** + +```typescript +arrival_date: Date; +``` diff --git a/docs-src/api/sncf.js.stoptime.arrival_time.md b/docs-src/api/sncf.js.stoptime.arrival_time.md index f35a90a4..24d5e8e8 100644 --- a/docs-src/api/sncf.js.stoptime.arrival_time.md +++ b/docs-src/api/sncf.js.stoptime.arrival_time.md @@ -4,6 +4,11 @@ ## StopTime.arrival\_time property +> Warning: This API is now obsolete. +> +> Use arrival\_date instead +> + Arrival time **Signature:** diff --git a/docs-src/api/sncf.js.stoptime.departure_date.md b/docs-src/api/sncf.js.stoptime.departure_date.md new file mode 100644 index 00000000..ff736371 --- /dev/null +++ b/docs-src/api/sncf.js.stoptime.departure_date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [StopTime](./sncf.js.stoptime.md) > [departure\_date](./sncf.js.stoptime.departure_date.md) + +## StopTime.departure\_date property + +Return the departure date of the train + +**Signature:** + +```typescript +departure_date: Date; +``` diff --git a/docs-src/api/sncf.js.stoptime.departure_time.md b/docs-src/api/sncf.js.stoptime.departure_time.md index 4a974f5a..7d4b2d0e 100644 --- a/docs-src/api/sncf.js.stoptime.departure_time.md +++ b/docs-src/api/sncf.js.stoptime.departure_time.md @@ -4,6 +4,11 @@ ## StopTime.departure\_time property +> Warning: This API is now obsolete. +> +> Use departure\_date instead +> + Departure time **Signature:** diff --git a/docs-src/api/sncf.js.stoptime.md b/docs-src/api/sncf.js.stoptime.md index 717dc162..39e405eb 100644 --- a/docs-src/api/sncf.js.stoptime.md +++ b/docs-src/api/sncf.js.stoptime.md @@ -12,19 +12,230 @@ export declare class StopTime ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.stoptime._constructor_.md) | | Constructs a new instance of the StopTime class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data, date)](./sncf.js.stoptime._constructor_.md) + + + + + + + +Constructs a new instance of the `StopTime` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_time](./sncf.js.stoptime.arrival_time.md) | | string | Arrival time | -| [departure\_time](./sncf.js.stoptime.departure_time.md) | | string | Departure time | -| [drop\_off](./sncf.js.stoptime.drop_off.md) | | boolean | Return boolean if drop off is available | -| [headsign](./sncf.js.stoptime.headsign.md) | | string | Return the headsign of the train | -| [pick\_up](./sncf.js.stoptime.pick_up.md) | | boolean | Return boolean if pick up is available | -| [skipped](./sncf.js.stoptime.skipped.md) | | boolean | Return boolean if the stop is skipped | -| [stop\_area](./sncf.js.stoptime.stop_area.md) | | [StopArea](./sncf.js.stoparea.md) | Return the stop area | + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date](./sncf.js.stoptime.arrival_date.md) + + + + + + + +Date + + + + +Return the arrival date of the train + + +
+ +[arrival\_time](./sncf.js.stoptime.arrival_time.md) + + + + + + + +string + + + + +Arrival time + + +
+ +[departure\_date](./sncf.js.stoptime.departure_date.md) + + + + + + + +Date + + + + +Return the departure date of the train + + +
+ +[departure\_time](./sncf.js.stoptime.departure_time.md) + + + + + + + +string + + + + +Departure time + + +
+ +[drop\_off](./sncf.js.stoptime.drop_off.md) + + + + + + + +boolean + + + + +Return boolean if drop off is available + + +
+ +[headsign](./sncf.js.stoptime.headsign.md) + + + + + + + +string + + + + +Return the headsign of the train + + +
+ +[pick\_up](./sncf.js.stoptime.pick_up.md) + + + + + + + +boolean + + + + +Return boolean if pick up is available + + +
+ +[skipped](./sncf.js.stoptime.skipped.md) + + + + + + + +boolean + + + + +Return boolean if the stop is skipped + + +
+ +[stop\_area](./sncf.js.stoptime.stop_area.md) + + + + + + + +[StopArea](./sncf.js.stoparea.md) + + + + +Return the stop area + +
diff --git a/docs-src/api/sncf.js.structuresmanager.md b/docs-src/api/sncf.js.structuresmanager.md index 27a9ec07..2aa7290d 100644 --- a/docs-src/api/sncf.js.structuresmanager.md +++ b/docs-src/api/sncf.js.structuresmanager.md @@ -12,26 +12,353 @@ export declare class StructuresManager ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)()](./sncf.js.structuresmanager._constructor_.md) | | Constructs a new instance of the StructuresManager class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)()](./sncf.js.structuresmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `StructuresManager` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [class\_administrative\_region](./sncf.js.structuresmanager.class_administrative_region.md) | readonly | typeof [AdministrativeRegion](./sncf.js.administrativeregion.md) | Get AdministartiveRegion constructor | -| [class\_arrival](./sncf.js.structuresmanager.class_arrival.md) | readonly | typeof [Arrival](./sncf.js.arrival.md) | Get arrival constructor | -| [class\_calendar](./sncf.js.structuresmanager.class_calendar.md) | readonly | typeof [Calendar](./sncf.js.calendar.md) | Get Calendar constructor | -| [class\_departure](./sncf.js.structuresmanager.class_departure.md) | readonly | typeof [Departure](./sncf.js.departure.md) | Get departure constructor | -| [class\_disruption](./sncf.js.structuresmanager.class_disruption.md) | readonly | typeof [Disruption](./sncf.js.disruption.md) | Get class\_disruption constructor | -| [class\_impacted\_stop](./sncf.js.structuresmanager.class_impacted_stop.md) | readonly | typeof [ImpactedStop](./sncf.js.impactedstop.md) | Get ImpactedStop constructor | -| [class\_journey](./sncf.js.structuresmanager.class_journey.md) | readonly | typeof [Journey](./sncf.js.journey.md) | Get Journey constructor | -| [class\_line](./sncf.js.structuresmanager.class_line.md) | readonly | typeof [Line](./sncf.js.line.md) | Get Line constructor | -| [class\_route](./sncf.js.structuresmanager.class_route.md) | readonly | typeof [Route](./sncf.js.route.md) | Get Route constructor | -| [class\_step](./sncf.js.structuresmanager.class_step.md) | readonly | typeof [Step](./sncf.js.step.md) | Get Step constructor | -| [class\_stop\_area](./sncf.js.structuresmanager.class_stop_area.md) | readonly | typeof [StopArea](./sncf.js.stoparea.md) | Get StopArea constructor | -| [class\_stop\_step](./sncf.js.structuresmanager.class_stop_step.md) | readonly | typeof [StopStep](./sncf.js.stopstep.md) | Get StopStep constructor | -| [class\_stop\_time](./sncf.js.structuresmanager.class_stop_time.md) | readonly | typeof [StopTime](./sncf.js.stoptime.md) | Get StopTime constructor | -| [class\_vehicle](./sncf.js.structuresmanager.class_vehicle.md) | readonly | typeof [Vehicle](./sncf.js.vehicle.md) | Get Vehicle constructor | + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[class\_administrative\_region](./sncf.js.structuresmanager.class_administrative_region.md) + + + + +`readonly` + + + + +typeof [AdministrativeRegion](./sncf.js.administrativeregion.md) + + + + +Get AdministartiveRegion constructor + + +
+ +[class\_arrival](./sncf.js.structuresmanager.class_arrival.md) + + + + +`readonly` + + + + +typeof [Arrival](./sncf.js.arrival.md) + + + + +Get arrival constructor + + +
+ +[class\_calendar](./sncf.js.structuresmanager.class_calendar.md) + + + + +`readonly` + + + + +typeof [Calendar](./sncf.js.calendar.md) + + + + +Get Calendar constructor + + +
+ +[class\_departure](./sncf.js.structuresmanager.class_departure.md) + + + + +`readonly` + + + + +typeof [Departure](./sncf.js.departure.md) + + + + +Get departure constructor + + +
+ +[class\_disruption](./sncf.js.structuresmanager.class_disruption.md) + + + + +`readonly` + + + + +typeof [Disruption](./sncf.js.disruption.md) + + + + +Get class\_disruption constructor + + +
+ +[class\_impacted\_stop](./sncf.js.structuresmanager.class_impacted_stop.md) + + + + +`readonly` + + + + +typeof [ImpactedStop](./sncf.js.impactedstop.md) + + + + +Get ImpactedStop constructor + + +
+ +[class\_journey](./sncf.js.structuresmanager.class_journey.md) + + + + +`readonly` + + + + +typeof [Journey](./sncf.js.journey.md) + + + + +Get Journey constructor + + +
+ +[class\_line](./sncf.js.structuresmanager.class_line.md) + + + + +`readonly` + + + + +typeof [Line](./sncf.js.line.md) + + + + +Get Line constructor + + +
+ +[class\_route](./sncf.js.structuresmanager.class_route.md) + + + + +`readonly` + + + + +typeof [Route](./sncf.js.route.md) + + + + +Get Route constructor + + +
+ +[class\_step](./sncf.js.structuresmanager.class_step.md) + + + + +`readonly` + + + + +typeof [Step](./sncf.js.step.md) + + + + +Get Step constructor + + +
+ +[class\_stop\_area](./sncf.js.structuresmanager.class_stop_area.md) + + + + +`readonly` + + + + +typeof [StopArea](./sncf.js.stoparea.md) + + + + +Get StopArea constructor + + +
+ +[class\_stop\_step](./sncf.js.structuresmanager.class_stop_step.md) + + + + +`readonly` + + + + +typeof [StopStep](./sncf.js.stopstep.md) + + + + +Get StopStep constructor + + +
+ +[class\_stop\_time](./sncf.js.structuresmanager.class_stop_time.md) + + + + +`readonly` + + + + +typeof [StopTime](./sncf.js.stoptime.md) + + + + +Get StopTime constructor + + +
+ +[class\_vehicle](./sncf.js.structuresmanager.class_vehicle.md) + + + + +`readonly` + + + + +typeof [Vehicle](./sncf.js.vehicle.md) + + + + +Get Vehicle constructor + +
diff --git a/docs-src/api/sncf.js.time.md b/docs-src/api/sncf.js.time.md index 33a135a5..0eb2ab17 100644 --- a/docs-src/api/sncf.js.time.md +++ b/docs-src/api/sncf.js.time.md @@ -12,8 +12,63 @@ export interface Time ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [base\_date](./sncf.js.time.base_date.md) | | Date | The scheduled date | -| [real\_date](./sncf.js.time.real_date.md) | | Date | The real date | + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[base\_date](./sncf.js.time.base_date.md) + + + + + + + +Date + + + + +The scheduled date + + +
+ +[real\_date](./sncf.js.time.real_date.md) + + + + + + + +Date + + + + +The real date + + +
diff --git a/docs-src/api/sncf.js.timeimpact.md b/docs-src/api/sncf.js.timeimpact.md index a32e2a51..4155a55e 100644 --- a/docs-src/api/sncf.js.timeimpact.md +++ b/docs-src/api/sncf.js.timeimpact.md @@ -12,9 +12,82 @@ export interface TimeImpact ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [base\_time](./sncf.js.timeimpact.base_time.md) | | string | Return the base time of the impact | -| [real\_time](./sncf.js.timeimpact.real_time.md) | | string | Return the real time of the impact | -| [status](./sncf.js.timeimpact.status.md) | | string | Return the status of the impact | + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[base\_time](./sncf.js.timeimpact.base_time.md) + + + + + + + +string + + + + +Return the base time of the impact + + +
+ +[real\_time](./sncf.js.timeimpact.real_time.md) + + + + + + + +string + + + + +Return the real time of the impact + + +
+ +[status](./sncf.js.timeimpact.status.md) + + + + + + + +string + + + + +Return the status of the impact + + +
diff --git a/docs-src/api/sncf.js.traininfo.md b/docs-src/api/sncf.js.traininfo.md index 567ec4f3..50e4f900 100644 --- a/docs-src/api/sncf.js.traininfo.md +++ b/docs-src/api/sncf.js.traininfo.md @@ -12,11 +12,120 @@ export interface TrainInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [commercial\_mode](./sncf.js.traininfo.commercial_mode.md) | | string | The train commercial mode | -| [direction](./sncf.js.traininfo.direction.md) | | string | The train direction | -| [headsign](./sncf.js.traininfo.headsign.md) | | string | The train identifier | -| [name](./sncf.js.traininfo.name.md) | | string | The train name | -| [physical\_mode](./sncf.js.traininfo.physical_mode.md) | | string | The train physical mode | + + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[commercial\_mode](./sncf.js.traininfo.commercial_mode.md) + + + + + + + +string + + + + +The train commercial mode + + +
+ +[direction](./sncf.js.traininfo.direction.md) + + + + + + + +string + + + + +The train direction + + +
+ +[headsign](./sncf.js.traininfo.headsign.md) + + + + + + + +string + + + + +The train identifier + + +
+ +[name](./sncf.js.traininfo.name.md) + + + + + + + +string + + + + +The train name + + +
+ +[physical\_mode](./sncf.js.traininfo.physical_mode.md) + + + + + + + +string + + + + +The train physical mode + + +
diff --git a/docs-src/api/sncf.js.vehicle._constructor_.md b/docs-src/api/sncf.js.vehicle._constructor_.md index 9f6ae5e6..e87dd8a2 100644 --- a/docs-src/api/sncf.js.vehicle._constructor_.md +++ b/docs-src/api/sncf.js.vehicle._constructor_.md @@ -14,8 +14,48 @@ constructor(Client: any, data: any); ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| Client | any | | -| data | any | | + + + +
+Parameter + + + + +Type + + + + +Description + + +
+ +Client + + + + +any + + + + + +
+ +data + + + + +any + + + + + +
diff --git a/docs-src/api/sncf.js.vehicle.arrival_date.md b/docs-src/api/sncf.js.vehicle.arrival_date.md new file mode 100644 index 00000000..bacf2c6b --- /dev/null +++ b/docs-src/api/sncf.js.vehicle.arrival_date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [Vehicle](./sncf.js.vehicle.md) > [arrival\_date](./sncf.js.vehicle.arrival_date.md) + +## Vehicle.arrival\_date property + +Return the arrival date of the vehicle + +**Signature:** + +```typescript +arrival_date: Date; +``` diff --git a/docs-src/api/sncf.js.vehicle.arrival_time.md b/docs-src/api/sncf.js.vehicle.arrival_time.md index 3379f4ed..9bcba88b 100644 --- a/docs-src/api/sncf.js.vehicle.arrival_time.md +++ b/docs-src/api/sncf.js.vehicle.arrival_time.md @@ -4,6 +4,11 @@ ## Vehicle.arrival\_time property +> Warning: This API is now obsolete. +> +> Use arrival\_date instead +> + Return the arrival time of the vehicle **Signature:** diff --git a/docs-src/api/sncf.js.vehicle.departure_date.md b/docs-src/api/sncf.js.vehicle.departure_date.md new file mode 100644 index 00000000..6b3e5fef --- /dev/null +++ b/docs-src/api/sncf.js.vehicle.departure_date.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [sncf.js](./sncf.js.md) > [Vehicle](./sncf.js.vehicle.md) > [departure\_date](./sncf.js.vehicle.departure_date.md) + +## Vehicle.departure\_date property + +Return the departure date of the vehicle + +**Signature:** + +```typescript +departure_date: Date; +``` diff --git a/docs-src/api/sncf.js.vehicle.departure_time.md b/docs-src/api/sncf.js.vehicle.departure_time.md index a10748ea..a65b1f34 100644 --- a/docs-src/api/sncf.js.vehicle.departure_time.md +++ b/docs-src/api/sncf.js.vehicle.departure_time.md @@ -4,6 +4,11 @@ ## Vehicle.departure\_time property +> Warning: This API is now obsolete. +> +> Use arrival\_date instead +> + Return the departure time of the vehicle **Signature:** diff --git a/docs-src/api/sncf.js.vehicle.md b/docs-src/api/sncf.js.vehicle.md index 01b021ad..bcc80055 100644 --- a/docs-src/api/sncf.js.vehicle.md +++ b/docs-src/api/sncf.js.vehicle.md @@ -12,23 +12,308 @@ export declare class Vehicle ## Constructors -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(Client, data)](./sncf.js.vehicle._constructor_.md) | | Constructs a new instance of the Vehicle class | + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(Client, data)](./sncf.js.vehicle._constructor_.md) + + + + + + + +Constructs a new instance of the `Vehicle` class + + +
## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [arrival\_time](./sncf.js.vehicle.arrival_time.md) | | string | Return the arrival time of the vehicle | -| [calendar](./sncf.js.vehicle.calendar.md) | | [Calendar](./sncf.js.calendar.md)\[\] | Return the calendar of the vehicle | -| [departure\_time](./sncf.js.vehicle.departure_time.md) | | string | Return the departure time of the vehicle | -| [disruptions](./sncf.js.vehicle.disruptions.md) | readonly | [Disruption](./sncf.js.disruption.md)\[\] | Return the vehicle disruptions | -| [get\_arrival\_time](./sncf.js.vehicle.get_arrival_time.md) | readonly | string | | -| [get\_departure\_time](./sncf.js.vehicle.get_departure_time.md) | readonly | string | | -| [has\_disruptions](./sncf.js.vehicle.has_disruptions.md) | | boolean | Return boolean if the vehicle has disruptions | -| [headsign](./sncf.js.vehicle.headsign.md) | | string | Return the vehicle headsign | -| [id](./sncf.js.vehicle.id.md) | | string | Return the vehicle id | -| [stop\_times](./sncf.js.vehicle.stop_times.md) | | [StopTime](./sncf.js.stoptime.md)\[\] | Return the steps of the vehicle | -| [trip\_id](./sncf.js.vehicle.trip_id.md) | | string | Return trip ID | + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[arrival\_date](./sncf.js.vehicle.arrival_date.md) + + + + + + + +Date + + + + +Return the arrival date of the vehicle + + +
+ +[arrival\_time](./sncf.js.vehicle.arrival_time.md) + + + + + + + +string + + + + +Return the arrival time of the vehicle + + +
+ +[calendar](./sncf.js.vehicle.calendar.md) + + + + + + + +[Calendar](./sncf.js.calendar.md)\[\] + + + + +Return the calendar of the vehicle + + +
+ +[departure\_date](./sncf.js.vehicle.departure_date.md) + + + + + + + +Date + + + + +Return the departure date of the vehicle + + +
+ +[departure\_time](./sncf.js.vehicle.departure_time.md) + + + + + + + +string + + + + +Return the departure time of the vehicle + + +
+ +[disruptions](./sncf.js.vehicle.disruptions.md) + + + + +`readonly` + + + + +[Disruption](./sncf.js.disruption.md)\[\] + + + + +Return the vehicle disruptions + + +
+ +[get\_arrival\_time](./sncf.js.vehicle.get_arrival_time.md) + + + + +`readonly` + + + + +string + + + + + +
+ +[get\_departure\_time](./sncf.js.vehicle.get_departure_time.md) + + + + +`readonly` + + + + +string + + + + + +
+ +[has\_disruptions](./sncf.js.vehicle.has_disruptions.md) + + + + + + + +boolean + + + + +Return boolean if the vehicle has disruptions + + +
+ +[headsign](./sncf.js.vehicle.headsign.md) + + + + + + + +string + + + + +Return the vehicle headsign + + +
+ +[id](./sncf.js.vehicle.id.md) + + + + + + + +string + + + + +Return the vehicle id + + +
+ +[stop\_times](./sncf.js.vehicle.stop_times.md) + + + + + + + +[StopTime](./sncf.js.stoptime.md)\[\] + + + + +Return the steps of the vehicle + + +
+ +[trip\_id](./sncf.js.vehicle.trip_id.md) + + + + + + + +string + + + + +Return trip ID + +
diff --git a/docs-src/api/sncf.js.weekpattern.md b/docs-src/api/sncf.js.weekpattern.md index e27f2491..291b42e4 100644 --- a/docs-src/api/sncf.js.weekpattern.md +++ b/docs-src/api/sncf.js.weekpattern.md @@ -12,13 +12,144 @@ export interface WeekPattern ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [friday](./sncf.js.weekpattern.friday.md) | | boolean | | -| [monday](./sncf.js.weekpattern.monday.md) | | boolean | | -| [saturday](./sncf.js.weekpattern.saturday.md) | | boolean | | -| [sunday](./sncf.js.weekpattern.sunday.md) | | boolean | | -| [thursday](./sncf.js.weekpattern.thursday.md) | | boolean | | -| [tuesday](./sncf.js.weekpattern.tuesday.md) | | boolean | | -| [wednesday](./sncf.js.weekpattern.wednesday.md) | | boolean | | + + + + + + + + +
+Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[friday](./sncf.js.weekpattern.friday.md) + + + + + + + +boolean + + + + + +
+ +[monday](./sncf.js.weekpattern.monday.md) + + + + + + + +boolean + + + + + +
+ +[saturday](./sncf.js.weekpattern.saturday.md) + + + + + + + +boolean + + + + + +
+ +[sunday](./sncf.js.weekpattern.sunday.md) + + + + + + + +boolean + + + + + +
+ +[thursday](./sncf.js.weekpattern.thursday.md) + + + + + + + +boolean + + + + + +
+ +[tuesday](./sncf.js.weekpattern.tuesday.md) + + + + + + + +boolean + + + + + +
+ +[wednesday](./sncf.js.weekpattern.wednesday.md) + + + + + + + +boolean + + + + + +