@@ -215,7 +215,7 @@ import * as protobuf from "protobufjs";
215
215
216
216
Module Structure
217
217
----------------
218
- The library exports a flat ` protobuf ` namespace with the following members, ordered by category:
218
+ The library exports a flat ` protobuf ` namespace including but not restricted to the following members, ordered by category:
219
219
220
220
### Parser
221
221
@@ -225,49 +225,19 @@ The library exports a flat `protobuf` namespace with the following members, orde
225
225
* ** loadSync(filename: ` string|string[] ` , [ root: ` Root ` ] ): ` Root ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/index.js )] <br />
226
226
Synchronously loads one or multiple .proto or preprocessed .json files into a common root namespace (node only).
227
227
228
- * ** tokenize(source: ` string ` ): ` Object ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/tokenize.js )] <br />
229
- Tokenizes the given .proto source and returns an object with useful utility functions.
230
-
231
228
* ** parse(source: ` string ` ): ` Object ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/parse.js )] <br />
232
229
Parses the given .proto source and returns an object with the parsed contents.
233
230
234
- * ** package: ` string|undefined ` ** <br />
235
- The package name, if declared.
236
-
237
- * ** imports: ` string[]|undefined ` ** <br />
238
- File names of imported files, if any.
239
-
240
- * ** weakImports: ` string[]|undefined ` ** <br />
241
- File names of weakly imported files, if any.
242
-
243
- * ** syntax: ` string|undefined ` ** <br />
244
- Source syntax, if defined.
245
-
246
- * ** root: ` Root ` ** <br />
247
- The root namespace.
248
-
249
231
### Serialization
250
232
251
233
* ** Writer** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/writer.js )] <br />
252
234
Wire format writer using ` Uint8Array ` if available, otherwise ` Array ` .
253
235
254
- * ** BufferWriter** _ extends ** Writer** _ [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/writer.js )] <br />
255
- Wire format writer using node buffers.
256
-
257
236
* ** Reader** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/reader.js )] <br />
258
237
Wire format reader using ` Uint8Array ` if available, otherwise ` Array ` .
259
238
260
- * ** BufferReader** _ extends ** Reader** _ [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/reader.js )] <br />
261
- Wire format reader using node buffers.
262
-
263
- * ** codegen** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/codegen.js )] <br />
264
- A closure for generating functions programmatically.
265
-
266
239
### Reflection
267
240
268
- * ** ReflectionObject** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/object.js )] <br />
269
- Base class of all reflection objects.
270
-
271
241
* ** Namespace** _ extends ** ReflectionObject** _ [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/namespace.js )] <br />
272
242
Base class of all reflection objects containing nested objects.
273
243
@@ -302,18 +272,11 @@ The library exports a flat `protobuf` namespace with the following members, orde
302
272
303
273
### Utility
304
274
305
- * ** types: ` Object ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/types.js )] <br />
306
- Common type constants.
307
-
308
- * ** common(name: ` string ` , json: ` Object ` )** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/common.js )] <br />
309
- Provides common type definitions.
310
-
311
- * ** rpc: ` Object ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/rpc.js )] <br />
312
- Streaming RPC helpers.
313
-
314
- * ** util: ` Object ` ** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/util.js )] <br />
275
+ * ** util** [[ source] ( https://github.com/dcodeIO/protobuf.js/blob/master/src/util.js )] <br />
315
276
Various utility functions.
316
277
278
+ For less common members, see the API documentation.
279
+
317
280
Documentation
318
281
-------------
319
282
0 commit comments