Kaitai Struct: runtime library for JavaScript

This library implements Kaitai Struct API for JavaScript.

Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.

Further reading:

• About Kaitai Struct
• About API implemented in this library
• JavaScript-specific notes - also includes Quick start guide

Development

After cloning this repository, you must run these commands to compile the TypeScript source file KaitaiStream.ts into the KaitaiStream.js file (ignored by Git) with JavaScript code:

npm install
npm run build

npm run build also needs to be run after each change to KaitaiStream.ts.

Licensing

Copyright 2012-2016 Ilmari Heikkinen\ Copyright 2016-2024 Kaitai Project

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.