s2-tools
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
219 lines • 7.21 kB
TypeScript
/**
* # GBFS Schema V3.1-RC OR GBFS Schema V3.0
* Auto-discovery file that links to all of the other files published by the system.
*
* ## Links
* - [GBFS Specification V3.1-RC](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#gbfsjson)
* - [GBFS Specification V3.0](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfsjson)
*/
export type GBFSV3 = GBFSV31RC | GBFSV30;
/**
* # GBFS Schema V3.1-RC
* Auto-discovery file that links to all of the other files published by the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#gbfsjson)
*/
export declare const gbfsSchemaV31RC: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
format: string;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
type: string;
properties: {
feeds: {
description: string;
type: string;
items: {
type: string;
properties: {
name: {
description: string;
type: string;
enum: string[];
};
url: {
description: string;
type: string;
format: string;
};
};
required: string[];
};
minItems: number;
};
};
required: string[];
};
};
additionalProperties: boolean;
required: string[];
};
/**
* # GBFS Schema V3.1-RC
* Auto-discovery file that links to all of the other files published by the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#gbfsjson)
*/
export interface GBFSV31RC {
/**
* Last time the data in the feed was updated in RFC3339 format.
* **format** date-time
*/
last_updated: string;
/**
* 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 (added in v1.1).
*/
version: '3.1-RC';
/**
* Contains the list of feeds published by the auto-discovery file.
*/
data: {
/**
* An array of all of the feeds that are published by the auto-discovery file.
* Each element in the array is an object with the keys below.
* **minItems** 1
*/
feeds: Array<{
/**
* Key identifying the type of feed this is.
* The key must be the base file name defined in the spec for the corresponding feed type.
*/
name: 'gbfs' | 'gbfs_versions' | 'system_information' | 'vehicle_types' | 'station_information' | 'station_status' | 'vehicle_status' | 'system_alerts' | 'system_regions' | 'system_pricing_plans' | 'geofencing_zones';
/**
* URL for the feed.
* **format** uri
*/
url: string;
}>;
};
}
/**
* # GBFS Schema V3.0
* Auto-discovery file that links to all of the other files published by the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfsjson)
*/
export declare const gbfsSchemaV30: {
$schema: string;
$id: string;
description: string;
type: string;
properties: {
last_updated: {
description: string;
type: string;
format: string;
};
ttl: {
description: string;
type: string;
minimum: number;
};
version: {
description: string;
type: string;
const: string;
};
data: {
type: string;
properties: {
feeds: {
description: string;
type: string;
items: {
type: string;
properties: {
name: {
description: string;
type: string;
enum: string[];
};
url: {
description: string;
type: string;
format: string;
};
};
required: string[];
};
minItems: number;
};
};
required: string[];
};
};
additionalProperties: boolean;
required: string[];
};
/**
* # GBFS Schema V3.0
* Auto-discovery file that links to all of the other files published by the system.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#gbfsjson)
*/
export interface GBFSV30 {
/**
* Last time the data in the feed was updated in RFC3339 format.
* **Format**: date-time
*/
last_updated: string;
/**
* 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 (added in v1.1).
* **Const**: 3.0
*/
version: '3.0';
/**
* Contains the data for feeds published by the auto-discovery file.
*/
data: {
/**
* An array of all feeds published by the auto-discovery file. Each element is an object with the following keys:
*/
feeds: Array<{
/**
* Key identifying the type of feed this is. The key must be the base file name defined in the spec for the corresponding feed type.
* **Enum**: ['gbfs', 'gbfs_versions', 'system_information', 'vehicle_types', 'station_information', 'station_status', 'vehicle_status', 'system_alerts', 'system_regions', 'system_pricing_plans', 'geofencing_zones']
*/
name: 'gbfs' | 'gbfs_versions' | 'system_information' | 'vehicle_types' | 'station_information' | 'station_status' | 'vehicle_status' | 'system_alerts' | 'system_regions' | 'system_pricing_plans' | 'geofencing_zones';
/**
* URL for the feed.
* **Format**: uri
*/
url: string;
}>;
};
}
//# sourceMappingURL=gbfs.d.ts.map