Repository files navigation

This library implements Kaitai Struct API for JavaScript.

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

Further reading:

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

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

npm installnpm run build

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

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 athttp://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.