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
42 lines (41 loc) • 2.21 kB
TypeScript
export declare const BIKEPOINT_DATA: {
readonly section: "BikePoint";
readonly endpoints: readonly [{
readonly path: "/BikePoint";
readonly method: "GET";
readonly summary: "Gets all bike point locations. The Place object has an addtionalProperties array which contains the nbBikes, nbDocks and nbSpaces\r\n numbers which give the status of the BikePoint. A mismatch in these numbers i.e. nbDocks - (nbBikes + nbSpaces) != 0 indicates broken docks.";
readonly parameters: readonly [];
readonly returnType: "Place[]";
readonly deprecated: false;
readonly tags: readonly ["BikePoint"];
}, {
readonly path: "/BikePoint/{id}";
readonly method: "GET";
readonly summary: "Gets the bike point with the given id.";
readonly parameters: readonly [{
readonly name: "id";
readonly type: "string";
readonly required: true;
readonly description: "A bike point id (a list of ids can be obtained from the above BikePoint call)";
}];
readonly returnType: "Place";
readonly deprecated: false;
readonly tags: readonly ["BikePoint"];
}, {
readonly path: "/BikePoint/Search";
readonly method: "GET";
readonly summary: "Search for bike stations by their name, a bike point's name often contains information about the name of the street\r\n or nearby landmarks, for example. Note that the search result does not contain the PlaceProperties i.e. the status\r\n or occupancy of the BikePoint, to get that information you should retrieve the BikePoint by its id on /BikePoint/id.";
readonly parameters: readonly [{
readonly name: "query";
readonly type: "string";
readonly required: true;
readonly description: "The search term e.g. \"St. James\"";
}];
readonly returnType: "Place[]";
readonly deprecated: false;
readonly tags: readonly ["BikePoint"];
}];
readonly totalEndpoints: 3;
readonly generatedAt: "2025-07-10T01:28:59.105Z";
};
export type BIKEPOINT_DATAType = typeof BIKEPOINT_DATA;