UNPKG

tfl-ts

Version:

🚇 Fully-typed TypeScript client for Transport for London (TfL) API • Zero dependencies • Auto-generated types • Real-time arrivals • Journey planning • Universal compatibility

github.com/ghcpuman902/tfl-ts

ghcpuman902/tfl-ts

119 lines (118 loc) • 5.86 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
export declare const ROAD_DATA: { readonly section: "Road"; readonly endpoints: readonly [{ readonly path: "/Road"; readonly method: "GET"; readonly summary: "Gets all roads managed by TfL"; readonly parameters: readonly []; readonly returnType: "RoadCorridor[]"; readonly deprecated: false; readonly tags: readonly ["Road"]; }, { readonly path: "/Road/{ids}"; readonly method: "GET"; readonly summary: "Gets the road with the specified id (e.g. A1)"; readonly parameters: readonly [{ readonly name: "ids"; readonly type: "any"; readonly required: true; readonly description: "Comma-separated list of road identifiers e.g. \"A406, A2\" (a full list of supported road identifiers can be found at the /Road/ endpoint)"; }]; readonly returnType: "RoadCorridor[]"; readonly deprecated: false; readonly tags: readonly ["Road"]; }, { readonly path: "/Road/{ids}/Status"; readonly method: "GET"; readonly summary: "Gets the specified roads with the status aggregated over the date range specified, or now until the end of today if no dates are passed."; readonly parameters: readonly [{ readonly name: "ids"; readonly type: "any"; readonly required: true; readonly description: "Comma-separated list of road identifiers e.g. \"A406, A2\" or use \"all\" to ignore id filter (a full list of supported road identifiers can be found at the /Road/ endpoint)"; }, { readonly name: "dateRangeNullable.startDate"; readonly type: "string"; readonly required: false; }, { readonly name: "dateRangeNullable.endDate"; readonly type: "string"; readonly required: false; }]; readonly returnType: "RoadCorridor[]"; readonly deprecated: false; readonly tags: readonly ["Road"]; }, { readonly path: "/Road/{ids}/Disruption"; readonly method: "GET"; readonly summary: "Get active disruptions, filtered by road ids"; readonly parameters: readonly [{ readonly name: "ids"; readonly type: "any"; readonly required: true; readonly description: "Comma-separated list of road identifiers e.g. \"A406, A2\" use all for all to ignore id filter (a full list of supported road identifiers can be found at the /Road/ endpoint)"; }, { readonly name: "stripContent"; readonly type: "boolean"; readonly required: false; readonly description: "Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location, comments and streets"; }, { readonly name: "severities"; readonly type: "any"; readonly required: false; readonly description: "an optional list of Severity names to filter on (a valid list of severities can be obtained from the /Road/Meta/severities endpoint)"; }, { readonly name: "categories"; readonly type: "any"; readonly required: false; readonly description: "an optional list of category names to filter on (a valid list of categories can be obtained from the /Road/Meta/categories endpoint)"; }, { readonly name: "closures"; readonly type: "boolean"; readonly required: false; readonly description: "Optional, defaults to true. When true, always includes disruptions that have road closures, regardless of the severity filter. When false, the severity filter works as normal."; }]; readonly returnType: "RoadDisruption[]"; readonly deprecated: false; readonly tags: readonly ["Road"]; }, { readonly path: "/Road/all/Street/Disruption"; readonly method: "GET"; readonly summary: "Gets a list of disrupted streets. If no date filters are provided, current disruptions are returned."; readonly parameters: readonly [{ readonly name: "startDate"; readonly type: "string"; readonly required: true; readonly description: "Optional, the start time to filter on."; }, { readonly name: "endDate"; readonly type: "string"; readonly required: true; readonly description: "Optional, The end time to filter on."; }]; readonly returnType: "Object"; readonly deprecated: false; readonly tags: readonly ["Road"]; }, { readonly path: "/Road/all/Disruption/{disruptionIds}"; readonly method: "GET"; readonly summary: "Gets a list of active disruptions filtered by disruption Ids."; readonly parameters: readonly [{ readonly name: "disruptionIds"; readonly type: "any"; readonly required: true; readonly description: "Comma-separated list of disruption identifiers to filter by."; }, { readonly name: "stripContent"; readonly type: "boolean"; readonly required: false; readonly description: "Optional, defaults to false. When true, removes every property/node except for id, point, severity, severityDescription, startDate, endDate, corridor details, location and comments."; }]; readonly returnType: "RoadDisruption"; readonly deprecated: false; readonly tags: readonly ["Road"]; }]; readonly totalEndpoints: 6; readonly generatedAt: "2025-07-10T01:28:59.106Z"; }; export type ROAD_DATAType = typeof ROAD_DATA;