https://github.com/kaitai-io/kaitai_struct_javascript_runtime

Kaitai Struct: runtime for JavaScript
https://github.com/kaitai-io/kaitai_struct_javascript_runtime

javascript kaitai-struct

Last synced: 10 days ago
JSON representation

Kaitai Struct: runtime for JavaScript

• Host: GitHub
• URL: https://github.com/kaitai-io/kaitai_struct_javascript_runtime
• Owner: kaitai-io
• License: apache-2.0
• Created: 2016-03-09T19:42:51.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T17:05:33.000Z (9 months ago)
• Last Synced: 2024-04-14T08:21:50.189Z (9 months ago)
• Topics: javascript, kaitai-struct
• Language: JavaScript
• Size: 77.1 KB
• Stars: 31
• Watchers: 8
• Forks: 21
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-kaitai - Repository - io/kaitai_struct_javascript_runtime/issues)) (Runtimes / CI)

README

        
# Kaitai Struct: runtime library for JavaScript

[![npm@latest](https://img.shields.io/npm/v/kaitai-struct/latest)](https://www.npmjs.com/package/kaitai-struct/v/latest)

[![npm@next](https://img.shields.io/npm/v/kaitai-struct/next)](https://www.npmjs.com/package/kaitai-struct/v/next)

[![downloads](https://img.shields.io/npm/dw/kaitai-struct)](https://www.npmtrends.com/kaitai-struct)

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](http://kaitai.io/)

* [About API implemented in this library](http://doc.kaitai.io/stream_api.html)

* [JavaScript-specific notes](http://doc.kaitai.io/lang_javascript.html) - also includes Quick start guide

## Development

After cloning this repository, you must run these commands to compile the

TypeScript source file [`KaitaiStream.ts`](./KaitaiStream.ts) into the

`KaitaiStream.js` file (ignored by Git) with JavaScript code:

```shell

npm install

npm run build

```

`npm run build` also needs to be run after each change to

[`KaitaiStream.ts`](./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.