\n \n \n
Streaming GTFS and GTFS-RT parser for node.
\n\n\n# gtfs-stream [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![TypeScript][typescript-image]][typescript-url]\n\n\n## Install\n\n```\nnpm install gtfs-stream --save\n```\n\n## Plain GTFS\n\n```ts\nimport { plain } from 'gtfs-stream'\n\nrequest.get('https://developers.google.com/transit/gtfs/examples/sample-feed.zip') // or any other way of getting the data stream\n .pipe(plain())\n .on('data', (entity) => {\n console.log(entity)\n })\n```\n\nData events emitted from the GTFS parse stream have the following shape:\n\n- type (String, feed_info, agency, stop, route, trip, stop_time, calendar, calendar_date, fare_attribute, fare_rule, shape, frequency, transfer)\n- data (Object)\n - See https://developers.google.com/transit/gtfs/examples/gtfs-feed for the available attributes of each type\n\nIf you want the raw rows, you can pass `{ raw: true }` to this function to skip type inference. This library also provides TypeScript type definitions for all GTFS entities.\n\n## GTFS Enhanced\n\nThe base GTFS format is cumbersome to work with, so the enhanced parser will do a little extra work piecing things together to make it more usable. This parser will use more memory than the base parser since it needs to collect rows that need formatting while it waits for other to stream in.\n\n```ts\nimport { enhanced } from 'gtfs-stream'\n\nrequest.get('https://developers.google.com/transit/gtfs/examples/sample-feed.zip') // or any other way of getting the data stream\n .pipe(enhanced())\n .on('data', (entity) => {\n console.log(entity)\n })\n```\n\n- type (String, feed_info, agency, stop, route, trip, calendar, calendar_date, fare_attribute, fare_rule, shape, frequency, transfer)\n- data (Object)\n - See https://developers.google.com/transit/gtfs/examples/gtfs-feed for the available attributes of each type\n\nDifferences from the base parser:\n- `trip` types have a new `path` attribute that is a GeoJSON LineString, and `shape_id` is removed\n- `stop` types have a new `schedule` attribute that is a collection of stop times\n- `route` types have a human-readable `route_type`\n- `stop` types have a human-readable `location_type` and `wheelchair_boarding`\n- No `shape` or `stop_time` types, since they are collected into their relevant entries\n\n## GTFS-RT\n\n```ts\nimport { rt } from 'gtfs-stream'\n\nrequest.get('http://datamine.mta.info/mta_esi.php') // or any other way of getting the data stream\n .pipe(rt())\n .on('data', (entity) => {\n console.log(entity)\n })\n```\n\nData events emitted from the GTFS Realtime parse stream have the following shape:\n\n- id\n- is_deleted\n- trip_update\n - timestamp\n - delay\n - vehicle\n - stop_time_update\n - trip\n - trip_id\n - route_id\n - direction_id\n - start_time\n - start_date\n - schedule_relationship\n- vehicle\n - position\n - current_stop_sequence\n - stop_id\n - current_status\n - timestamp\n - congestion_level\n - occupancy_status\n - trip\n - trip_id\n - route_id\n - direction_id\n - start_time\n - start_date\n - schedule_relationship\n- alert\n - active_period\n - informed_entity\n - cause\n - effect\n - url\n - header_text\n - description_text\n\nOnly one of either trip_update, vehicle, or alert will be present in any given event.\n\n\n[downloads-image]: http://img.shields.io/npm/dm/gtfs-stream.svg\n[npm-url]: https://npmjs.org/package/gtfs-stream\n[npm-image]: http://img.shields.io/npm/v/gtfs-stream.svg\n[typescript-image]: https://img.shields.io/badge/TypeScript-blue.svg\n[typescript-url]: https://www.typescriptlang.org/\n","readmeFilename":"README.md"}