Skip to content

Commit d7885b8

Browse files
Alexis06030631Alexis06030631
committed
Update doc
1 parent 3bd14dc commit d7885b8

File tree

94 files changed

+7283
-519
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+7283
-519
lines changed

‎docs-src/.vitepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export default {
2727
{
2828
text: 'Managers',
2929
items: [
30+
{ text: 'SearchManager', link: '/api/sncf.js.searchmanager.html' },
3031
{ text: 'DisruptionManager', link: '/api/sncf.js.disruptionmanager.html' },
3132
{ text: 'JourneyManager', link: '/api/sncf.js.journeymanager.html' },
3233
{ text: 'LineManager', link: '/api/sncf.js.linemanager.html' },

‎docs-src/api/index.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,24 @@
66

77
## Packages
88

9-
| Package | Description |
10-
| --- | --- |
11-
| [sncf.js](./sncf.js.md) | |
9+
<table><thead><tr><th>
1210

11+
Package
12+
13+
14+
</th><th>
15+
16+
Description
17+
18+
19+
</th></tr></thead>
20+
<tbody><tr><td>
21+
22+
[sncf.js](./sncf.js.md)
23+
24+
25+
</td><td>
26+
27+
28+
</td></tr>
29+
</tbody></table>

‎docs-src/api/sncf.js.activeperiods.md

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,63 @@ export interface ActivePeriods
1212

1313
## Properties
1414

15-
| Property | Modifiers | Type | Description |
16-
| --- | --- | --- | --- |
17-
| [end\_date](./sncf.js.activeperiods.end_date.md) | | Date | The end date of the active period |
18-
| [start\_date](./sncf.js.activeperiods.start_date.md) | | Date | The start date of the active period |
15+
<table><thead><tr><th>
1916

17+
Property
18+
19+
20+
</th><th>
21+
22+
Modifiers
23+
24+
25+
</th><th>
26+
27+
Type
28+
29+
30+
</th><th>
31+
32+
Description
33+
34+
35+
</th></tr></thead>
36+
<tbody><tr><td>
37+
38+
[end\_date](./sncf.js.activeperiods.end_date.md)
39+
40+
41+
</td><td>
42+
43+
44+
</td><td>
45+
46+
Date
47+
48+
49+
</td><td>
50+
51+
The end date of the active period
52+
53+
54+
</td></tr>
55+
<tr><td>
56+
57+
[start\_date](./sncf.js.activeperiods.start_date.md)
58+
59+
60+
</td><td>
61+
62+
63+
</td><td>
64+
65+
Date
66+
67+
68+
</td><td>
69+
70+
The start date of the active period
71+
72+
73+
</td></tr>
74+
</tbody></table>

‎docs-src/api/sncf.js.administrativeregion._constructor_.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,48 @@ constructor(Client: any, data: any);
1414

1515
## Parameters
1616

17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| Client | any | |
20-
| data | any | |
17+
<table><thead><tr><th>
2118

19+
Parameter
20+
21+
22+
</th><th>
23+
24+
Type
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
Client
36+
37+
38+
</td><td>
39+
40+
any
41+
42+
43+
</td><td>
44+
45+
46+
</td></tr>
47+
<tr><td>
48+
49+
data
50+
51+
52+
</td><td>
53+
54+
any
55+
56+
57+
</td><td>
58+
59+
60+
</td></tr>
61+
</tbody></table>

‎docs-src/api/sncf.js.administrativeregion.md

Lines changed: 147 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,154 @@ export declare class AdministrativeRegion
1212

1313
## Constructors
1414

15-
| Constructor | Modifiers | Description |
16-
| --- | --- | --- |
17-
| [(constructor)(Client, data)](./sncf.js.administrativeregion._constructor_.md) | | Constructs a new instance of the <code>AdministrativeRegion</code> class |
15+
<table><thead><tr><th>
16+
17+
Constructor
18+
19+
20+
</th><th>
21+
22+
Modifiers
23+
24+
25+
</th><th>
26+
27+
Description
28+
29+
30+
</th></tr></thead>
31+
<tbody><tr><td>
32+
33+
[(constructor)(Client, data)](./sncf.js.administrativeregion._constructor_.md)
34+
35+
36+
</td><td>
37+
38+
39+
</td><td>
40+
41+
Constructs a new instance of the `AdministrativeRegion` class
42+
43+
44+
</td></tr>
45+
</tbody></table>
1846

1947
## Properties
2048

21-
| Property | Modifiers | Type | Description |
22-
| --- | --- | --- | --- |
23-
| [coord](./sncf.js.administrativeregion.coord.md) | | [Coord](./sncf.js.coord.md) | Return the coordinate of the stop area |
24-
| [id](./sncf.js.administrativeregion.id.md) | | string | Return the stop area id |
25-
| [insee](./sncf.js.administrativeregion.insee.md) | | string | Return the stop area zip code |
26-
| [name](./sncf.js.administrativeregion.name.md) | | string | Return the stop area name |
27-
| [timezone](./sncf.js.administrativeregion.timezone.md) | | number | Return the stop area level |
49+
<table><thead><tr><th>
50+
51+
Property
52+
53+
54+
</th><th>
55+
56+
Modifiers
57+
58+
59+
</th><th>
60+
61+
Type
62+
63+
64+
</th><th>
65+
66+
Description
67+
68+
69+
</th></tr></thead>
70+
<tbody><tr><td>
71+
72+
[coord](./sncf.js.administrativeregion.coord.md)
73+
74+
75+
</td><td>
76+
77+
78+
</td><td>
79+
80+
[Coord](./sncf.js.coord.md)
81+
82+
83+
</td><td>
84+
85+
Return the coordinate of the stop area
86+
87+
88+
</td></tr>
89+
<tr><td>
90+
91+
[id](./sncf.js.administrativeregion.id.md)
92+
93+
94+
</td><td>
95+
96+
97+
</td><td>
98+
99+
string
100+
101+
102+
</td><td>
103+
104+
Return the stop area id
105+
106+
107+
</td></tr>
108+
<tr><td>
109+
110+
[insee](./sncf.js.administrativeregion.insee.md)
111+
112+
113+
</td><td>
114+
115+
116+
</td><td>
117+
118+
string
119+
120+
121+
</td><td>
122+
123+
Return the stop area zip code
124+
125+
126+
</td></tr>
127+
<tr><td>
128+
129+
[name](./sncf.js.administrativeregion.name.md)
130+
131+
132+
</td><td>
133+
134+
135+
</td><td>
136+
137+
string
138+
139+
140+
</td><td>
141+
142+
Return the stop area name
143+
144+
145+
</td></tr>
146+
<tr><td>
147+
148+
[timezone](./sncf.js.administrativeregion.timezone.md)
149+
150+
151+
</td><td>
152+
153+
154+
</td><td>
155+
156+
number
157+
158+
159+
</td><td>
160+
161+
Return the stop area level
162+
28163

164+
</td></tr>
165+
</tbody></table>

‎docs-src/api/sncf.js.arrival._constructor_.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,48 @@ constructor(Client: any, data: any);
1414

1515
## Parameters
1616

17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| Client | any | |
20-
| data | any | |
17+
<table><thead><tr><th>
2118

19+
Parameter
20+
21+
22+
</th><th>
23+
24+
Type
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
Client
36+
37+
38+
</td><td>
39+
40+
any
41+
42+
43+
</td><td>
44+
45+
46+
</td></tr>
47+
<tr><td>
48+
49+
data
50+
51+
52+
</td><td>
53+
54+
any
55+
56+
57+
</td><td>
58+
59+
60+
</td></tr>
61+
</tbody></table>

0 commit comments

Comments
 (0)