![]() |
FlatBuffers
An open source project by FPL.
|
Before diving into the FlatBuffers usage in TypeScript, it should be noted that the Tutorial page has a complete guide to general FlatBuffers usage in all of the supported languages (including TypeScript). This page is specifically designed to cover the nuances of FlatBuffers usage in TypeScript.
You should also have read the Building documentation to build flatc
and should be familiar with Using the schema compiler and Writing a schema.
The code for the FlatBuffers TypeScript library can be found at flatbuffers/js
with typings available at @types/flatbuffers
.
To run the tests, use the TypeScriptTest.sh shell script.
Note: The TypeScript test file requires Node.js.
Note: See Tutorial for a more in-depth example of how to use FlatBuffers in TypeScript.
FlatBuffers supports both reading and writing FlatBuffers in TypeScript.
To use FlatBuffers in your own code, first generate TypeScript classes from your schema with the --ts
option to flatc
. Then you can include both FlatBuffers and the generated code to read or write a FlatBuffer.
For example, here is how you would read a FlatBuffer binary file in TypeScript: First, include the library and generated code. Then read the file into an Uint8Array
. Make a flatbuffers.ByteBuffer
out of the Uint8Array
, and pass the ByteBuffer to the getRootAsMonster
function.
Now you can access values like this:
There currently is no support for parsing text (Schema's and JSON) directly from TypeScript.