gis-tools-ts - v0.6.0
    Preparing search index...

    Class GTFSRealtimeHeader

    Metadata about a feed, included in feed messages.

    Index

    Constructors

    constructor

    Properties

    feedVersion? gtfsRealtimeVersion incrementality timestamp?

    Constructors

    • Parameters

      • pbf: PbfReader

        The Protobuf object to read from

      • end: number

        The end position of the message in the buffer

      Returns GTFSRealtimeHeader

    Properties

    feedVersion?: string

    String that matches the feed_info.feed_version from the GTFS feed that the real time data is based on. Consumers can use this to identify which GTFS feed is currently active or when a new one is available to download.

    gtfsRealtimeVersion: string = '2'

    Version of the feed specification. The current version is 2.0. Valid versions are "2.0", "1.0".

    incrementality: Incrementality = Incrementality.FULL_DATASET

    Determines whether the current fetch is incremental. Currently, DIFFERENTIAL mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized.

    timestamp?: Date

    This timestamp identifies the moment when the content of this feed has been created (in server time). In POSIX time (i.e., number of seconds since January 1st 1970 00:00:00 UTC).

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties