mobility-toolbox-js
Version:
Toolbox for JavaScript applications in the domains of mobility and logistics.
77 lines (76 loc) • 2.01 kB
TypeScript
export default dummy;
export type Station = GeoJSONFeature;
export type StationProperties = {
transfers: Transfer[];
elevatorOutOfOrder: boolean;
uic: number;
name: string;
networkLines: NetworkLine[];
hasElevator: boolean;
hasZOB: boolean;
hasAccessibility: boolean;
type: string;
};
export type NetworkLine = {
/**
* Identifier of the line.
*/
id: number;
/**
* Color of the line (CSS color string).
*/
color: string;
/**
* Stroke color of the line (CSS color string).
*/
stroke: string;
/**
* Name of the line.
*/
name: string;
/**
* Text color of the line (CSS color string).
*/
text_color: string;
};
export type Transfer = {
/**
* Mode of transportation (ex: U-Bahn).
*/
mot: string;
/**
* Array of lines name (ex: ["U4", "U5"]).
*/
lines: string[];
};
/**
* @typedef {GeoJSONFeature} Station
* @property {StationProperties} properties Returns the station's properties.
* @property {GeoJSONPoint} geometry Returns a point.
*/
/**
* @typedef {Object} StationProperties
* @property {Transfer[]} transfers
* @property {boolean} elevatorOutOfOrder
* @property {number} uic
* @property {string} name
* @property {NetworkLine[]} networkLines
* @property {boolean} hasElevator
* @property {boolean} hasZOB
* @property {boolean} hasAccessibility
* @property {string} type
*/
/**
* @typedef {Object} NetworkLine
* @property {number} id Identifier of the line.
* @property {string} color Color of the line (CSS color string).
* @property {string} stroke Stroke color of the line (CSS color string).
* @property {string} name Name of the line.
* @property {string} text_color Text color of the line (CSS color string).
*/
/**
* @typedef {Object} Transfer
* @property {string} mot Mode of transportation (ex: U-Bahn).
* @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
*/
declare function dummy(): void;