s2-tools
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
247 lines • 7.83 kB
TypeScript
/**
* # GBFS System Regions Schema V3.1-RC & V3.0
* Describes regions for a system that is broken up by geographic or political region.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_regionsjson)
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_regionsjson)
*/
export type GBFSSystemRegionsV3 = GBFSSystemRegionsV31RC | GBFSSystemRegionsV30;
/**
* # GBFS System Regions Schema V3.1-RC
* Describes regions for a system that is broken up by geographic or political region.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_regionsjson)
*/
export declare const gbfsSystemRegionsSchemaV31RC: {
$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: {
description: string;
type: string;
properties: {
regions: {
description: string;
type: string;
items: {
type: string;
properties: {
region_id: {
description: string;
type: string;
};
name: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS System Regions Schema V3.1-RC
* Describes regions for a system that is broken up by geographic or political region.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.1-RC/gbfs.md#system_regionsjson)
*/
export interface GBFSSystemRegionsV31RC {
/**
* 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.1-RC
*/
version: '3.1-RC';
/**
* Contains the region data for the system.
*/
data: {
/**
* Array of regions for the system.
*/
regions: Array<{
/**
* Identifier of the region.
*/
region_id: string;
/**
* Public name for this region.
*/
name: Array<{
/**
* The translated text of the region name.
*/
text: string;
/**
* IETF BCP 47 language code.
* **Pattern**: `^[a-z]{2,3}(-[A-Z]{2})?$`
*/
language: string;
}>;
}>;
};
}
/**
* # GBFS System Regions Schema V3.0
* Describes regions for a system that is broken up by geographic or political region.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_regionsjson)
*/
export declare const gbfsSystemRegionsSchemaV30: {
$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: {
description: string;
type: string;
properties: {
regions: {
description: string;
type: string;
items: {
type: string;
properties: {
region_id: {
description: string;
type: string;
};
name: {
description: string;
type: string;
items: {
type: string;
properties: {
text: {
description: string;
type: string;
};
language: {
description: string;
type: string;
pattern: string;
};
};
required: string[];
};
};
};
required: string[];
};
};
};
required: string[];
};
};
required: string[];
};
/**
* # GBFS System Regions Schema V3.0
* Describes regions for a system that is broken up by geographic or political region.
*
* ## Links
* - [GBFS Specification](https://github.com/MobilityData/gbfs/blob/v3.0/gbfs.md#system_regionsjson)
*/
export interface GBFSSystemRegionsV30 {
/**
* Last time the data in the feed was updated in RFC3339 format.
*/
last_updated: string;
/**
* Number of seconds before the data in the feed will be updated again (0 if the data should always be refreshed).
*/
ttl: number;
/**
* GBFS version number to which the feed conforms.
*/
version: '3.0';
/**
* Data describing regions for a system.
*/
data: {
/**
* Array of regions.
*/
regions: Array<{
/**
* Identifier of the region.
*/
region_id: string;
/**
* Public name for this region.
*/
name: Array<{
text: string;
language: string;
}>;
}>;
};
}
//# sourceMappingURL=systemRegions.d.ts.map