-
Notifications
You must be signed in to change notification settings - Fork 132
Add JavaScript / Deno support #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
taisukef
wants to merge
6
commits into
MobilityData:master
Choose a base branch
from
taisukef:add_deno_support
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b04e03a
add deno support
taisukef b4259e7
Update README.md
taisukef 8992cf9
Update README.md
taisukef 761e0c9
add test-local
taisukef af7fb48
Merge branch 'add_deno_support' of https://github.com/taisukef/gtfs-r…
taisukef b790ea5
fix doc
taisukef File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # JavaScript GTFS-realtime Language Bindings | ||
|
|
||
| Provides JavaScript classes generated from the | ||
| [GTFS-realtime](https://github.com/google/transit/tree/master/gtfs-realtime) Protocol | ||
| Buffer specification. These classes will allow you to parse a binary Protocol | ||
| Buffer GTFS-realtime data feed into JavaScript objects. | ||
|
|
||
| These bindings are designed to be used in the [Deno](https://deno.land/) | ||
| environment, but with some effort, they can probably be used in other | ||
| JavaScript environments as well. | ||
|
|
||
| We use the [protbuf-es.js](https://github.com/taisukef/protobuf-es.js/) library for | ||
| JavaScript Protocol Buffer support. | ||
|
|
||
| ## Example Code | ||
|
|
||
| The following Node.js code snippet demonstrates downloading a GTFS-realtime | ||
| data feed from a particular URL, parsing it as a FeedMessage (the root type of | ||
| the GTFS-realtime schema), and iterating over the results. | ||
|
|
||
| ```javascript | ||
| import { GtfsRealtimeApi } from "https://taisukef.github.io/gtfs-realtime-bindings/deno/gtfs-realtime.js"; | ||
|
|
||
| const data = await Deno.readFile("test/vehicle_position.pb"); | ||
| const feed = GtfsRealtimeApi.transit_realtime.FeedMessage.decode(data); | ||
| console.log(feed); | ||
| console.log(feed.entity[0].vehicle); | ||
| ``` | ||
|
|
||
| For more details on the naming conventions for the JavaScript classes generated | ||
| from the | ||
| [gtfs-realtime.proto](https://github.com/google/transit/blob/master/gtfs-realtime/proto/gtfs-realtime.proto), | ||
| check out the [ProtoBuf.js project](https://github.com/dcodeIO/ProtoBuf.js/wiki) | ||
| which we use to handle our Protocol Buffer serialization. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # How-To Update Bindings When gtfs-realtime.proto Changes | ||
|
|
||
| ## Regenerate the language binding source from gtfs-realtime.proto. | ||
|
|
||
| 1. make nodejs/gtfs-realtime.js and edit as ES module | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Due to the overhead of maintaining bindings in multiple languages, we've been shying away from adopting any new languages where the update process can't be automated. It looks like this updating process requires hand-editing to update the bindings? More details here are needed.
@maximearmstrong would need to weigh in on MobilityData's willingness to take on the additional responsibility of manually updating these bindings going forward.
Related - we should update the "Other languages" section of the README to more specifically itemize the requirements for new binding language contributions (e.g., supported by official PB tooling, process to update and publish release can be automated).