Skip to content

Commit 602065e

Browse files
committed
Docs: Clarified typescript example in README, see #744
1 parent 3d23eed commit 602065e

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -444,18 +444,24 @@ import * as protobuf from "protobufjs";
444444
import * as Long from "long"; // optional
445445

446446
// browser only (alternatively)
447-
import * as protobuf from "./node_modules/protobufjs/index.js";
448-
import * as Long from "./node_modules/long/dist/long.js"; // optional
447+
// import * as protobuf from "./node_modules/protobufjs/index.js";
448+
// import * as Long from "./node_modules/long/dist/long.js"; // optional
449449

450450
protobuf.load("awesome.proto", function(err, root) {
451451
if (err)
452452
throw err;
453453

454454
// example code
455-
var AwesomeMessage = root.lookupType("AwesomeMessage");
456-
var message = AwesomeMessage.create({ awesomeField: "hello" });
457-
var buffer = AwesomeMessage.encode(message).finish();
458-
...
455+
const AwesomeMessage = root.lookupType("awesomepackage.AwesomeMessage");
456+
457+
let message = AwesomeMessage.create({ awesomeField: "hello" });
458+
console.log(`message = ${JSON.stringify(message)}`);
459+
460+
let buffer = AwesomeMessage.encode(message).finish();
461+
console.log(`buffer = ${Array.prototype.slice.call(buffer)}`);
462+
463+
let decoded = AwesomeMessage.decode(buffer);
464+
console.log(`decoded = ${JSON.stringify(decoded)}`);
459465
});
460466
```
461467

src/encoder.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ function encoder(mtype) {
4242
type = field.resolvedType instanceof Enum ? "uint32" : field.type,
4343
wireType = types.basic[type];
4444
ref = "m" + util.safeProp(field.name);
45-
45+
4646
// Map fields
4747
if (field.map) {
4848
gen

0 commit comments

Comments
 (0)