s2-tools
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
683 lines • 24.9 kB
TypeScript
/**
* # GBFS Station Status Schema V2.3, V2.2, V2.1, OR V2.0
* List of all stations, their capacities, and locations. REQUIRED for systems utilizing docks.
*
* ## Links
* - [GBFS Specification V2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#station_statusjson)
* - [GBFS Specification V2.2](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md#station_statusjson)
* - [GBFS Specification V2.1](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#station_statusjson)
* - [GBFS Specification V2.0](https://github.com/MobilityData/gbfs/blob/v2.0/gbfs.md#station_statusjson)
*/
export type GBFSStationStatusV2 = GBFSStationStatusV23 | GBFSStationStatusV22 | GBFSStationStatusV21 | GBFSStationStatusV20;
/**
* # GBFS Station Status Schema V2.3
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#station_statusjson)
*/
export declare const gbfsStationStatusSchemaV23: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
stations: {
type: string;
items: {
type: string;
properties: {
station_id: {
description: string;
type: string;
};
num_bikes_available: {
description: string;
type: string;
minimum: number;
};
vehicle_types_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
num_bikes_disabled: {
description: string;
type: string;
minimum: number;
};
num_docks_available: {
description: string;
type: string;
minimum: number;
};
num_docks_disabled: {
description: string;
type: string;
minimum: number;
};
is_installed: {
description: string;
type: string;
};
is_renting: {
description: string;
type: string;
};
is_returning: {
description: string;
type: string;
};
last_reported: {
description: string;
type: string;
minimum: number;
};
vehicle_docks_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_ids: {
description: string;
type: string;
items: {
type: string;
};
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Station Status V2.3
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md#station_statusjson)
*/
export interface GBFSStationStatusV23 {
/**
* Last time the data in the feed was updated in POSIX time.
* **Minimum**: 1450155600
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms, according to the versioning framework.
* **Const**: 2.3
*/
version: '2.3';
/**
* Contains station status information.
*/
data: {
/**
* Array of station status objects.
*/
stations: Array<{
station_id: string;
num_bikes_available: number;
vehicle_types_available?: Array<{
vehicle_type_id: string;
count: number;
}>;
num_bikes_disabled?: number;
num_docks_available?: number;
num_docks_disabled?: number;
is_installed: boolean;
is_renting: boolean;
is_returning: boolean;
last_reported: number;
vehicle_docks_available?: Array<{
vehicle_type_ids: string[];
count: number;
}>;
}>;
};
}
/**
* # GBFS Station Status Schema V2.2
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md#station_statusjson)
*/
export declare const gbfsStationStatusSchemaV22: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
stations: {
type: string;
items: {
type: string;
properties: {
station_id: {
description: string;
type: string;
};
num_bikes_available: {
description: string;
type: string;
minimum: number;
};
vehicle_types_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
num_bikes_disabled: {
description: string;
type: string;
minimum: number;
};
num_docks_available: {
description: string;
type: string;
minimum: number;
};
num_docks_disabled: {
description: string;
type: string;
minimum: number;
};
is_installed: {
description: string;
type: string;
};
is_renting: {
description: string;
type: string;
};
is_returning: {
description: string;
type: string;
};
last_reported: {
description: string;
type: string;
minimum: number;
};
vehicle_docks_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_ids: {
description: string;
type: string;
items: {
type: string;
};
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Station Status V2.2
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md#station_statusjson)
*/
export interface GBFSStationStatusV22 {
/**
* Last time the data in the feed was updated in POSIX time.
* **Minimum**: 1450155600
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms, according to the versioning framework.
* **Const**: 2.2
*/
version: '2.2';
/**
* Contains station status information.
*/
data: {
/**
* Array of station status objects.
*/
stations: Array<{
station_id: string;
num_bikes_available: number;
vehicle_types_available?: Array<{
vehicle_type_id: string;
count: number;
}>;
num_bikes_disabled?: number;
num_docks_available?: number;
num_docks_disabled?: number;
is_installed: boolean;
is_renting: boolean;
is_returning: boolean;
last_reported: number;
vehicle_docks_available?: Array<{
vehicle_type_ids: string[];
count: number;
}>;
}>;
};
}
/**
* # GBFS Station Status Schema V2.1
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#station_statusjson)
*/
export declare const gbfsStationStatusSchemaV21: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
stations: {
type: string;
items: {
type: string;
properties: {
station_id: {
description: string;
type: string;
};
num_bikes_available: {
description: string;
type: string;
minimum: number;
};
vehicle_types_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_id: {
description: string;
type: string;
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
num_bikes_disabled: {
description: string;
type: string;
minimum: number;
};
num_docks_available: {
description: string;
type: string;
minimum: number;
};
num_docks_disabled: {
description: string;
type: string;
minimum: number;
};
is_installed: {
description: string;
type: string;
};
is_renting: {
description: string;
type: string;
};
is_returning: {
description: string;
type: string;
};
last_reported: {
description: string;
type: string;
minimum: number;
};
vehicle_docks_available: {
description: string;
type: string;
items: {
type: string;
properties: {
vehicle_type_ids: {
description: string;
type: string;
items: {
type: string;
};
};
count: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Station Status V2.1
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md#station_statusjson)
*/
export interface GBFSStationStatusV21 {
/**
* Last time the data in the feed was updated in POSIX time.
* **Minimum**: 1450155600
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms, according to the versioning framework.
* **Const**: 2.1
*/
version: '2.1';
/**
* Contains station status information.
*/
data: {
/**
* Array of station status objects.
*/
stations: Array<{
station_id: string;
num_bikes_available: number;
vehicle_types_available?: Array<{
vehicle_type_id: string;
count: number;
}>;
num_bikes_disabled?: number;
num_docks_available?: number;
num_docks_disabled?: number;
is_installed: boolean;
is_renting: boolean;
is_returning: boolean;
last_reported: number;
vehicle_docks_available?: Array<{
vehicle_type_ids: string[];
count: number;
}>;
}>;
};
}
/**
* # GBFS Station Status Schema V2.0
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.0/gbfs.md#station_statusjson)
*/
export declare const gbfsStationStatusSchemaV20: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
minimum: number;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
description: string;
type: string;
properties: {
stations: {
type: string;
items: {
type: string;
properties: {
station_id: {
description: string;
type: string;
};
num_bikes_available: {
description: string;
type: string;
minimum: number;
};
num_bikes_disabled: {
description: string;
type: string;
minimum: number;
};
num_docks_available: {
description: string;
type: string;
minimum: number;
};
num_docks_disabled: {
description: string;
type: string;
minimum: number;
};
is_installed: {
description: string;
type: string;
};
is_renting: {
description: string;
type: string;
};
is_returning: {
description: string;
type: string;
};
last_reported: {
description: string;
type: string;
minimum: number;
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS Station Status V2.0
* Describes the capacity and rental availability of the station.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v2.0/gbfs.md#station_statusjson)
*/
export interface GBFSStationStatusV20 {
/**
* Last time the data in the feed was updated in POSIX time.
* **Minimum**: 1450155600
*/
last_updated: number;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
* **Minimum**: 0
*/
ttl: number;
/**
* GBFS version number to which the feed conforms, according to the versioning framework.
* **Const**: 2.0
*/
version: '2.0';
/**
* Contains station status information.
*/
data: {
/**
* Array of station status objects.
*/
stations: Array<{
station_id: string;
num_bikes_available: number;
num_bikes_disabled?: number;
num_docks_available?: number;
num_docks_disabled?: number;
is_installed: boolean;
is_renting: boolean;
is_returning: boolean;
last_reported: number;
}>;
};
}
//# sourceMappingURL=stationStatus.d.ts.map