caber 0.1.1

Embed binary data into JavaScript and TypeScript projects.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

# caber

Embed binary data into JavaScript and TypeScript projects.

## Install

```shell
cargo install caber --features cli
```

## How-to

```shell
> caber --help
caber 0.1.1
Gerald Nash (aunyks)
Embed binary data into JavaScript and TypeScript projects.

USAGE:
    caber [OPTIONS] <INPUT_FILE>

ARGS:
    <INPUT_FILE>    The binary to be embedded

OPTIONS:
    -h, --help                         Print help information
    -l, --output-lang <OUTPUT_LANG>    The output language of the binary (javascript / ecmascript,
                                       typescript, etc)
    -m, --export-mode <EXPORT_MODE>    The export mode of the typed array (default, object, or none)
    -o, --output-file <OUTPUT_FILE>    The output file containing the embedded file
    -V, --version                      Print version information
```

## Examples

Embed a `file.bin` file and export the typed array with `export default ...`. The result is written to stdout.

```shell
> caber ./file.bin
const binary = new Uint8Array([104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]);

export { binary };
```

Embed a `file.bin` file into a `file.ts` TypeScript file and export the typed array with `export default ...`.

```shell
> caber ./file.bin --output-lang typescript --export-mode default --output-file file.ts
```

Embed a `file.bin` file as JavaScript and export the typed array with `export { ... }`. The result is written to stdout.

```shell
> caber ./file.bin --output-lang javascript --export-mode object
const binary = new Uint8Array([104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]);

export { binary };
```

Embed a `file.bin` file as JavaScript and export the typed array with `export default ...`. The result is written to stdout.

```shell
> caber ./file.bin --output-lang javascript --export-mode default
const binary = new Uint8Array([104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100]);

export default binary;
```

## License

Fair Source License, Version 0.9  
Copyright © 2022 Gerald Nash