Liaisons de langage JavaScript GTFS-realtime

Fournit des classes JavaScript et leurs types associés générés à partir du GTFS-realtime Protocole Spécification du tampon. Ces classes vous permettront d’analyser un flux de données binaires en temps réel Protocol Buffer GTFS dans des objets JavaScript.

Ces liaisons sont conçues pour être utilisées dans l’environnement Node.js, mais avec quelques efforts, elles peuvent probablement être utilisées dans d’autres environnements JavaScript également.

Nous utilisons la bibliothèque ProtoBuf.js pour la prise en charge du tampon de protocole JavaScript.

Ajouter la dépendance

Pour utiliser les classes gtfs-realtime-bindings dans votre propre projet, vous devez d’abord installer notre package Node.js npm :

npm install gtfs-realtime-bindings

Exemple de code

Le nœud suivant L’extrait de code.js montre le téléchargement d’un flux de données GTFS Realtime à partir d’une URL particulière, son analyse en tant que FeedMessage (le type racine du du schéma GTFS Realtime) et l’itération sur les résultats.

Pour que cet exemple fonctionne, vous devez d’abord installer node-fetch avec NPM.

Remarque : cet exemple utilise des modules ES (syntaxe import/export ) et n’est pas compatible avec CommonJS (syntaxe require ). Vous pouvez utiliser CommonJS en convertissant import en require et en installant node-fetch@2. En savoir plus sur les modules ES ici.

import GtfsRealtimeBindings from "gtfs-realtime-bindings";
import fetch from "node-fetch";

(async () => {
  try {
    const response = await fetch("<GTFS-realtime source URL>", {
      headers: {
        "x-api-key": "<redacted>",
        // replace with your GTFS-realtime source's auth token
        // e.g. x-api-key is the header value used for NY's MTA GTFS APIs
      },
    });
    if (!response.ok) {
      const error = new Error(`${response.url}: ${response.status} ${response.statusText}`);
      error.response = response;
      throw error;
      process.exit(1);
    }
    const buffer = await response.arrayBuffer();
    const feed = GtfsRealtimeBindings.transit_realtime.FeedMessage.decode(
      new Uint8Array(buffer)
    );
    feed.entity.forEach((entity) => {
      if (entity.tripUpdate) {
        console.log(entity.tripUpdate);
      }
    });
  }
  catch (error) {
    console.log(error);
    process.exit(1);
  }
})();

Pour plus de détails sur les conventions de dénomination des classes JavaScript générées le gtfs-realtime.proto, consultez le projet ProtoBuf.js que nous utilisons pour gérer la sérialisation de notre tampon de protocole.