stage-browser 0.0.0-stage → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +136 -2
- package/build/icon.icns +0 -0
- package/build/icon.png +0 -0
- package/dist/bin/stage.js +111 -0
- package/dist/main/cli-args.js +28 -0
- package/dist/main/context-menu.js +68 -0
- package/dist/main/context.js +2 -0
- package/dist/main/extensions.js +78 -0
- package/dist/main/ipc.js +90 -0
- package/dist/main/main.js +279 -0
- package/dist/main/menu.js +140 -0
- package/dist/main/reveal.js +155 -0
- package/dist/main/selftest.js +490 -0
- package/dist/main/store.js +85 -0
- package/dist/main/suggest.js +43 -0
- package/dist/main/tabs.js +324 -0
- package/dist/main/url.js +38 -0
- package/dist/main/window.js +68 -0
- package/dist/preload/extension-compat.js +163 -0
- package/dist/preload/ui-preload.js +33 -0
- package/dist/shared/contract.js +6 -0
- package/dist/ui/app.js +653 -0
- package/dist/ui/index.html +41 -0
- package/dist/ui/mock.js +479 -0
- package/dist/ui/newtab.html +69 -0
- package/dist/ui/styles.css +410 -0
- package/node_modules/@types/chrome/LICENSE +21 -0
- package/node_modules/@types/chrome/README.md +15 -0
- package/node_modules/@types/chrome/chrome-cast/index.d.ts +1156 -0
- package/node_modules/@types/chrome/har-format/index.d.ts +6 -0
- package/node_modules/@types/chrome/index.d.ts +13786 -0
- package/node_modules/@types/chrome/package.json +99 -0
- package/node_modules/@types/filesystem/LICENSE +21 -0
- package/node_modules/@types/filesystem/README.md +15 -0
- package/node_modules/@types/filesystem/index.d.ts +564 -0
- package/node_modules/@types/filesystem/package.json +26 -0
- package/node_modules/@types/filewriter/LICENSE +21 -0
- package/node_modules/@types/filewriter/README.md +15 -0
- package/node_modules/@types/filewriter/index.d.ts +166 -0
- package/node_modules/@types/filewriter/package.json +25 -0
- package/node_modules/@types/har-format/LICENSE +21 -0
- package/node_modules/@types/har-format/README.md +15 -0
- package/node_modules/@types/har-format/index.d.ts +938 -0
- package/node_modules/@types/har-format/package.json +31 -0
- package/node_modules/adm-zip/LICENSE +21 -0
- package/node_modules/adm-zip/README.md +90 -0
- package/node_modules/adm-zip/adm-zip.js +1020 -0
- package/node_modules/adm-zip/headers/entryHeader.js +396 -0
- package/node_modules/adm-zip/headers/index.js +2 -0
- package/node_modules/adm-zip/headers/mainHeader.js +177 -0
- package/node_modules/adm-zip/methods/deflater.js +33 -0
- package/node_modules/adm-zip/methods/index.js +3 -0
- package/node_modules/adm-zip/methods/inflater.js +64 -0
- package/node_modules/adm-zip/methods/zipcrypto.js +175 -0
- package/node_modules/adm-zip/package.json +56 -0
- package/node_modules/adm-zip/types.d.ts +223 -0
- package/node_modules/adm-zip/util/constants.js +142 -0
- package/node_modules/adm-zip/util/decoder.js +5 -0
- package/node_modules/adm-zip/util/errors.js +66 -0
- package/node_modules/adm-zip/util/fattr.js +76 -0
- package/node_modules/adm-zip/util/index.js +5 -0
- package/node_modules/adm-zip/util/utils.js +481 -0
- package/node_modules/adm-zip/zipEntry.js +415 -0
- package/node_modules/adm-zip/zipFile.js +466 -0
- package/node_modules/debug/LICENSE +20 -0
- package/node_modules/debug/README.md +481 -0
- package/node_modules/debug/package.json +64 -0
- package/node_modules/debug/src/browser.js +272 -0
- package/node_modules/debug/src/common.js +292 -0
- package/node_modules/debug/src/index.js +10 -0
- package/node_modules/debug/src/node.js +263 -0
- package/node_modules/electron-chrome-web-store/README.md +143 -0
- package/node_modules/electron-chrome-web-store/dist/chrome-web-store.preload.js +299 -0
- package/node_modules/electron-chrome-web-store/dist/cjs/browser/index.js +1674 -0
- package/node_modules/electron-chrome-web-store/dist/esm/browser/index.mjs +950 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/api.d.ts +2 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/crx3.d.ts +20 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/id.d.ts +9 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/index.d.ts +62 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/installer.d.ts +29 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/loader.d.ts +18 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/types.d.ts +21 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/updater.d.ts +6 -0
- package/node_modules/electron-chrome-web-store/dist/types/browser/utils.d.ts +4 -0
- package/node_modules/electron-chrome-web-store/dist/types/common/constants.d.ts +44 -0
- package/node_modules/electron-chrome-web-store/dist/types/renderer/chrome-web-store.preload.d.ts +1 -0
- package/node_modules/electron-chrome-web-store/package.json +43 -0
- package/node_modules/ms/index.js +162 -0
- package/node_modules/ms/license.md +21 -0
- package/node_modules/ms/package.json +38 -0
- package/node_modules/ms/readme.md +59 -0
- package/node_modules/pbf/LICENSE +27 -0
- package/node_modules/pbf/README.md +293 -0
- package/node_modules/pbf/bin/pbf +17 -0
- package/node_modules/pbf/compile.js +441 -0
- package/node_modules/pbf/dist/pbf-dev.js +838 -0
- package/node_modules/pbf/dist/pbf.js +1 -0
- package/node_modules/pbf/index.d.ts +206 -0
- package/node_modules/pbf/index.js +830 -0
- package/node_modules/pbf/package.json +63 -0
- package/node_modules/protocol-buffers-schema/.travis.yml +7 -0
- package/node_modules/protocol-buffers-schema/LICENSE +21 -0
- package/node_modules/protocol-buffers-schema/README.md +122 -0
- package/node_modules/protocol-buffers-schema/example.js +11 -0
- package/node_modules/protocol-buffers-schema/example.proto +13 -0
- package/node_modules/protocol-buffers-schema/index.js +6 -0
- package/node_modules/protocol-buffers-schema/package.json +31 -0
- package/node_modules/protocol-buffers-schema/parse.js +769 -0
- package/node_modules/protocol-buffers-schema/stringify.js +206 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/basic.json +90 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/basic.proto +11 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/comments.json +99 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/comments.proto +19 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/complex.json +125 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/complex.proto +30 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/enum.json +42 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/enum.proto +8 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/escaped-quotes.json +32 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/escaped-quotes.proto +3 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/extend.json +167 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/extend.proto +19 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/import.json +30 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/import.proto +6 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/map.json +33 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/map.proto +3 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/no-tags.proto +8 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/oneof.json +41 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/oneof.proto +6 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/option.json +364 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/option.proto +72 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/options.json +47 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/options.proto +8 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/pheromon-trajectories.proto +8 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/reserved.json +55 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/reserved.proto +17 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/search.json +30 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/search.proto +5 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/service.json +108 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/service.proto +30 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/valid-packed.proto +35 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/version.json +90 -0
- package/node_modules/protocol-buffers-schema/test/fixtures/version.proto +13 -0
- package/node_modules/protocol-buffers-schema/test/index.js +157 -0
- package/node_modules/protocol-buffers-schema/tokenize.js +56 -0
- package/node_modules/resolve-protobuf-schema/.travis.yml +3 -0
- package/node_modules/resolve-protobuf-schema/LICENSE +21 -0
- package/node_modules/resolve-protobuf-schema/README.md +49 -0
- package/node_modules/resolve-protobuf-schema/index.js +50 -0
- package/node_modules/resolve-protobuf-schema/package.json +25 -0
- package/node_modules/resolve-protobuf-schema/test/a.proto +5 -0
- package/node_modules/resolve-protobuf-schema/test/b.proto +5 -0
- package/node_modules/resolve-protobuf-schema/test/c.proto +3 -0
- package/node_modules/resolve-protobuf-schema/test/index.js +49 -0
- package/package.json +64 -4
|
@@ -0,0 +1,293 @@
|
|
|
1
|
+
# pbf
|
|
2
|
+
|
|
3
|
+
[](https://github.com/mapbox/pbf/actions/workflows/node.yml)
|
|
4
|
+

|
|
5
|
+
|
|
6
|
+
A low-level, fast, ultra-lightweight (3KB gzipped) JavaScript library for decoding and encoding [protocol buffers](https://developers.google.com/protocol-buffers), a compact binary format for structured data serialization. Works both in Node and the browser. Supports lazy decoding and detailed customization of the reading/writing code.
|
|
7
|
+
|
|
8
|
+
## Performance
|
|
9
|
+
|
|
10
|
+
This library is extremely fast — much faster than native `JSON.parse`/`JSON.stringify`
|
|
11
|
+
and the [protocol-buffers](https://github.com/mafintosh/protocol-buffers) module.
|
|
12
|
+
Here's a result from running a real-world benchmark on Node v6.5
|
|
13
|
+
(decoding and encoding a sample of 439 vector tiles, 22.6 MB total):
|
|
14
|
+
|
|
15
|
+
- **pbf** decode: 387ms, or 57 MB/s
|
|
16
|
+
- **pbf** encode: 396ms, or 56 MB/s
|
|
17
|
+
- **protocol-buffers** decode: 837ms, or 26 MB/s
|
|
18
|
+
- **protocol-buffers** encode: 4197ms, or 5 MB/s
|
|
19
|
+
- **JSON.parse**: 1540ms, or 15 MB/s (parsing an equivalent 77.5 MB JSON file)
|
|
20
|
+
- **JSON.stringify**: 607ms, or 49 MB/s
|
|
21
|
+
|
|
22
|
+
## Examples
|
|
23
|
+
|
|
24
|
+
#### Using Compiled Code
|
|
25
|
+
|
|
26
|
+
Install `pbf` and compile a JavaScript module from a `.proto` file:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
$ npm install -g pbf
|
|
30
|
+
$ pbf example.proto > example.js
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Then read and write objects using the module like this:
|
|
34
|
+
|
|
35
|
+
```js
|
|
36
|
+
import Pbf from 'pbf';
|
|
37
|
+
import {readExample, writeExample} from './example.js';
|
|
38
|
+
|
|
39
|
+
// read
|
|
40
|
+
var obj = readExample(new Pbf(buffer));
|
|
41
|
+
|
|
42
|
+
// write
|
|
43
|
+
const pbf = new Pbf();
|
|
44
|
+
writeExample(obj, pbf);
|
|
45
|
+
const buffer = pbf.finish();
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Alternatively, you can compile a protobuf schema file directly in the code:
|
|
49
|
+
|
|
50
|
+
```js
|
|
51
|
+
import {compile} from 'pbf/compile';
|
|
52
|
+
import schema from 'protocol-buffers-schema';
|
|
53
|
+
|
|
54
|
+
const proto = schema.parse(fs.readFileSync('example.proto'));
|
|
55
|
+
const {readExample, writeExample} = compile(proto);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
#### Custom Reading
|
|
59
|
+
|
|
60
|
+
```js
|
|
61
|
+
var data = new Pbf(buffer).readFields(readData, {});
|
|
62
|
+
|
|
63
|
+
function readData(tag, data, pbf) {
|
|
64
|
+
if (tag === 1) data.name = pbf.readString();
|
|
65
|
+
else if (tag === 2) data.version = pbf.readVarint();
|
|
66
|
+
else if (tag === 3) data.layer = pbf.readMessage(readLayer, {});
|
|
67
|
+
}
|
|
68
|
+
function readLayer(tag, layer, pbf) {
|
|
69
|
+
if (tag === 1) layer.name = pbf.readString();
|
|
70
|
+
else if (tag === 3) layer.size = pbf.readVarint();
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
#### Custom Writing
|
|
75
|
+
|
|
76
|
+
```js
|
|
77
|
+
var pbf = new Pbf();
|
|
78
|
+
writeData(data, pbf);
|
|
79
|
+
var buffer = pbf.finish();
|
|
80
|
+
|
|
81
|
+
function writeData(data, pbf) {
|
|
82
|
+
pbf.writeStringField(1, data.name);
|
|
83
|
+
pbf.writeVarintField(2, data.version);
|
|
84
|
+
pbf.writeMessage(3, writeLayer, data.layer);
|
|
85
|
+
}
|
|
86
|
+
function writeLayer(layer, pbf) {
|
|
87
|
+
pbf.writeStringField(1, layer.name);
|
|
88
|
+
pbf.writeVarintField(2, layer.size);
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Install
|
|
93
|
+
|
|
94
|
+
Install using NPM with `npm install pbf`, then import as a module:
|
|
95
|
+
|
|
96
|
+
```js
|
|
97
|
+
import Pbf from 'pbf';
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Or use as a module directly in the browser with [jsDelivr](https://www.jsdelivr.com/esm):
|
|
101
|
+
|
|
102
|
+
```html
|
|
103
|
+
<script type="module">
|
|
104
|
+
import Pbf from 'https://cdn.jsdelivr.net/npm/pbf/+esm';
|
|
105
|
+
</script>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Alternatively, there's a browser bundle with a `Pbf` global variable:
|
|
109
|
+
|
|
110
|
+
```html
|
|
111
|
+
<script src="https://cdn.jsdelivr.net/npm/pbf"></script>
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## API
|
|
115
|
+
|
|
116
|
+
Create a `Pbf` object, optionally given a `Buffer` or `Uint8Array` as input data:
|
|
117
|
+
|
|
118
|
+
```js
|
|
119
|
+
// parse a pbf file from disk in Node
|
|
120
|
+
const pbf = new Pbf(fs.readFileSync('data.pbf'));
|
|
121
|
+
|
|
122
|
+
// parse a pbf file in a browser after an ajax request with responseType="arraybuffer"
|
|
123
|
+
const pbf = new Pbf(new Uint8Array(xhr.response));
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
`Pbf` object properties:
|
|
127
|
+
|
|
128
|
+
```js
|
|
129
|
+
pbf.length; // length of the underlying buffer
|
|
130
|
+
pbf.pos; // current offset for reading or writing
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
#### Reading
|
|
134
|
+
|
|
135
|
+
Read a sequence of fields:
|
|
136
|
+
|
|
137
|
+
```js
|
|
138
|
+
pbf.readFields((tag) => {
|
|
139
|
+
if (tag === 1) pbf.readVarint();
|
|
140
|
+
else if (tag === 2) pbf.readString();
|
|
141
|
+
else ...
|
|
142
|
+
});
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
It optionally accepts an object that will be passed to the reading function for easier construction of decoded data,
|
|
146
|
+
and also passes the `Pbf` object as a third argument:
|
|
147
|
+
|
|
148
|
+
```js
|
|
149
|
+
const result = pbf.readFields(readField, {})
|
|
150
|
+
|
|
151
|
+
function readField(tag, result, pbf) {
|
|
152
|
+
if (tag === 1) result.id = pbf.readVarint();
|
|
153
|
+
}
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
To read an embedded message, use `pbf.readMessage(fn[, obj])` (in the same way as `read`).
|
|
157
|
+
|
|
158
|
+
Read values:
|
|
159
|
+
|
|
160
|
+
```js
|
|
161
|
+
const value = pbf.readVarint();
|
|
162
|
+
const str = pbf.readString();
|
|
163
|
+
const numbers = pbf.readPackedVarint();
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
For lazy or partial decoding, simply save the position instead of reading a value,
|
|
167
|
+
then later set it back to the saved value and read:
|
|
168
|
+
|
|
169
|
+
```js
|
|
170
|
+
const fooPos = -1;
|
|
171
|
+
pbf.readFields((tag) => {
|
|
172
|
+
if (tag === 1) fooPos = pbf.pos;
|
|
173
|
+
});
|
|
174
|
+
...
|
|
175
|
+
pbf.pos = fooPos;
|
|
176
|
+
pbf.readMessage(readFoo);
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Scalar reading methods:
|
|
180
|
+
|
|
181
|
+
* `readVarint(isSigned)` (pass `true` if you expect negative varints)
|
|
182
|
+
* `readSVarint()`
|
|
183
|
+
* `readFixed32()`
|
|
184
|
+
* `readFixed64()`
|
|
185
|
+
* `readSFixed32()`
|
|
186
|
+
* `readSFixed64()`
|
|
187
|
+
* `readBoolean()`
|
|
188
|
+
* `readFloat()`
|
|
189
|
+
* `readDouble()`
|
|
190
|
+
* `readString()`
|
|
191
|
+
* `readBytes()`
|
|
192
|
+
* `skip(value)`
|
|
193
|
+
|
|
194
|
+
Packed reading methods:
|
|
195
|
+
|
|
196
|
+
* `readPackedVarint(arr, isSigned)` (appends read items to `arr`)
|
|
197
|
+
* `readPackedSVarint(arr)`
|
|
198
|
+
* `readPackedFixed32(arr)`
|
|
199
|
+
* `readPackedFixed64(arr)`
|
|
200
|
+
* `readPackedSFixed32(arr)`
|
|
201
|
+
* `readPackedSFixed64(arr)`
|
|
202
|
+
* `readPackedBoolean(arr)`
|
|
203
|
+
* `readPackedFloat(arr)`
|
|
204
|
+
* `readPackedDouble(arr)`
|
|
205
|
+
|
|
206
|
+
#### Writing
|
|
207
|
+
|
|
208
|
+
Write values:
|
|
209
|
+
|
|
210
|
+
```js
|
|
211
|
+
pbf.writeVarint(123);
|
|
212
|
+
pbf.writeString("Hello world");
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
Write an embedded message:
|
|
216
|
+
|
|
217
|
+
```js
|
|
218
|
+
pbf.writeMessage(1, writeObj, obj);
|
|
219
|
+
|
|
220
|
+
function writeObj(obj, pbf) {
|
|
221
|
+
pbf.writeStringField(obj.name);
|
|
222
|
+
pbf.writeVarintField(obj.version);
|
|
223
|
+
}
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Field writing methods:
|
|
227
|
+
|
|
228
|
+
* `writeVarintField(tag, val)`
|
|
229
|
+
* `writeSVarintField(tag, val)`
|
|
230
|
+
* `writeFixed32Field(tag, val)`
|
|
231
|
+
* `writeFixed64Field(tag, val)`
|
|
232
|
+
* `writeSFixed32Field(tag, val)`
|
|
233
|
+
* `writeSFixed64Field(tag, val)`
|
|
234
|
+
* `writeBooleanField(tag, val)`
|
|
235
|
+
* `writeFloatField(tag, val)`
|
|
236
|
+
* `writeDoubleField(tag, val)`
|
|
237
|
+
* `writeStringField(tag, val)`
|
|
238
|
+
* `writeBytesField(tag, buffer)`
|
|
239
|
+
|
|
240
|
+
Packed field writing methods:
|
|
241
|
+
|
|
242
|
+
* `writePackedVarint(tag, val)`
|
|
243
|
+
* `writePackedSVarint(tag, val)`
|
|
244
|
+
* `writePackedSFixed32(tag, val)`
|
|
245
|
+
* `writePackedSFixed64(tag, val)`
|
|
246
|
+
* `writePackedBoolean(tag, val)`
|
|
247
|
+
* `writePackedFloat(tag, val)`
|
|
248
|
+
* `writePackedDouble(tag, val)`
|
|
249
|
+
|
|
250
|
+
Scalar writing methods:
|
|
251
|
+
|
|
252
|
+
* `writeVarint(val)`
|
|
253
|
+
* `writeSVarint(val)`
|
|
254
|
+
* `writeSFixed32(val)`
|
|
255
|
+
* `writeSFixed64(val)`
|
|
256
|
+
* `writeBoolean(val)`
|
|
257
|
+
* `writeFloat(val)`
|
|
258
|
+
* `writeDouble(val)`
|
|
259
|
+
* `writeString(val)`
|
|
260
|
+
* `writeBytes(buffer)`
|
|
261
|
+
|
|
262
|
+
Message writing methods:
|
|
263
|
+
|
|
264
|
+
* `writeMessage(tag, fn[, obj])`
|
|
265
|
+
* `writeRawMessage(fn[, obj])`
|
|
266
|
+
|
|
267
|
+
Misc methods:
|
|
268
|
+
|
|
269
|
+
* `realloc(minBytes)` - pad the underlying buffer size to accommodate the given number of bytes;
|
|
270
|
+
note that the size increases exponentially, so it won't necessarily equal the size of data written
|
|
271
|
+
* `finish()` - make the current buffer ready for reading and return the data as a buffer slice
|
|
272
|
+
|
|
273
|
+
For an example of a real-world usage of the library, see [vector-tile-js](https://github.com/mapbox/vector-tile-js).
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
## Proto Schema to JavaScript
|
|
277
|
+
|
|
278
|
+
If installed globally, `pbf` provides a binary that compiles `proto` files into JavaScript modules. Usage:
|
|
279
|
+
|
|
280
|
+
```bash
|
|
281
|
+
$ pbf <proto_path> [--no-write] [--no-read] [--legacy]
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
The `--no-write` and `--no-read` switches remove corresponding code in the output.
|
|
285
|
+
The `--legacy` switch makes it generate a CommonJS module instead of ESM.
|
|
286
|
+
|
|
287
|
+
`Pbf` will generate `read<Identifier>` and `write<Identifier>` functions for every message in the schema. For nested messages, their names will be concatenated — e.g. `Message` inside `Test` will produce `readTestMessage` and `writeTestMessage` functions.
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
* `read(pbf)` - decodes an object from the given `Pbf` instance.
|
|
291
|
+
* `write(obj, pbf)` - encodes an object into the given `Pbf` instance (usually empty).
|
|
292
|
+
|
|
293
|
+
The resulting code is clean and simple, so it's meant to be customized.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
import resolve from 'resolve-protobuf-schema';
|
|
4
|
+
import {compileRaw} from '../compile.js';
|
|
5
|
+
|
|
6
|
+
if (process.argv.length < 3) {
|
|
7
|
+
console.error('Usage: pbf [file.proto] [--no-read] [--no-write] [--legacy]');
|
|
8
|
+
process.exit(0);
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
const code = compileRaw(resolve.sync(process.argv[2]), {
|
|
12
|
+
noRead: process.argv.indexOf('--no-read') >= 0,
|
|
13
|
+
noWrite: process.argv.indexOf('--no-write') >= 0,
|
|
14
|
+
legacy: process.argv.indexOf('--legacy') >= 0
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
process.stdout.write(code);
|