Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexis06030631 committed May 3, 2024
1 parent 3bd14dc commit d7885b8
Show file tree
Hide file tree
Showing 94 changed files with 7,283 additions and 519 deletions.
1 change: 1 addition & 0 deletions docs-src/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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' },
Expand Down
23 changes: 20 additions & 3 deletions docs-src/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,24 @@

## Packages

| Package | Description |
| --- | --- |
| [sncf.js](./sncf.js.md) | |
<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[sncf.js](./sncf.js.md)


</td><td>


</td></tr>
</tbody></table>
63 changes: 59 additions & 4 deletions docs-src/api/sncf.js.activeperiods.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[end\_date](./sncf.js.activeperiods.end_date.md)


</td><td>


</td><td>

Date


</td><td>

The end date of the active period


</td></tr>
<tr><td>

[start\_date](./sncf.js.activeperiods.start_date.md)


</td><td>


</td><td>

Date


</td><td>

The start date of the active period


</td></tr>
</tbody></table>
48 changes: 44 additions & 4 deletions docs-src/api/sncf.js.administrativeregion._constructor_.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,48 @@ constructor(Client: any, data: any);

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| Client | any | |
| data | any | |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

Client


</td><td>

any


</td><td>


</td></tr>
<tr><td>

data


</td><td>

any


</td><td>


</td></tr>
</tbody></table>
157 changes: 147 additions & 10 deletions docs-src/api/sncf.js.administrativeregion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <code>AdministrativeRegion</code> class |
<table><thead><tr><th>

Constructor


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[(constructor)(Client, data)](./sncf.js.administrativeregion._constructor_.md)


</td><td>


</td><td>

Constructs a new instance of the `AdministrativeRegion` class


</td></tr>
</tbody></table>

## 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 |
<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[coord](./sncf.js.administrativeregion.coord.md)


</td><td>


</td><td>

[Coord](./sncf.js.coord.md)


</td><td>

Return the coordinate of the stop area


</td></tr>
<tr><td>

[id](./sncf.js.administrativeregion.id.md)


</td><td>


</td><td>

string


</td><td>

Return the stop area id


</td></tr>
<tr><td>

[insee](./sncf.js.administrativeregion.insee.md)


</td><td>


</td><td>

string


</td><td>

Return the stop area zip code


</td></tr>
<tr><td>

[name](./sncf.js.administrativeregion.name.md)


</td><td>


</td><td>

string


</td><td>

Return the stop area name


</td></tr>
<tr><td>

[timezone](./sncf.js.administrativeregion.timezone.md)


</td><td>


</td><td>

number


</td><td>

Return the stop area level


</td></tr>
</tbody></table>
48 changes: 44 additions & 4 deletions docs-src/api/sncf.js.arrival._constructor_.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,48 @@ constructor(Client: any, data: any);

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| Client | any | |
| data | any | |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

Client


</td><td>

any


</td><td>


</td></tr>
<tr><td>

data


</td><td>

any


</td><td>


</td></tr>
</tbody></table>
Loading

0 comments on commit d7885b8

Please sign in to comment.