bufio - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

lib/bufio.js

@@ -16,2 +16,3 @@ /*!
 const HashWriter = require('./hashwriter');
+const Struct = require('./struct');
 
@@ -25,2 +26,3 @@ exports.encoding = encoding;
 exports.HashWriter = HashWriter;
+exports.Struct = Struct;
 
@@ -27,0 +29,0 @@ exports.read = function read(data, zeroCopy) {

lib/reader.js

@@ -92,3 +92,3 @@ /*!
     this.offset += off;
-    return off;
+    return this;
   }
@@ -158,2 +158,3 @@
     this.stack.length = 0;
+    return this;
   }
@@ -160,0 +161,0 @@

package.json

 {
   "name": "bufio",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Buffer and serialization utilities for javascript",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -21,2 +21,45 @@ # bufio
 
+## Struct Usage
+
+``` js
+const bio = require('bufio');
+
+class MyStruct extends bio.Struct {
+  constructor() {
+    super();
+    this.str = 'hello';
+    this.value = 0;
+  }
+
+  write(bw) {
+    bw.writeVarString(this.str, 'ascii');
+    bw.writeU64(this.value);
+    return this;
+  }
+
+  read(br) {
+    this.str = br.readVarString('ascii');
+    this.value = br.readU64();
+    return this;
+  }
+}
+
+const obj = new MyStruct();
+
+console.log('Buffer:');
+console.log(obj.encode());
+
+console.log('Decoded:');
+console.log(MyStruct.decode(obj.encode()));
+
+console.log('Hex:');
+console.log(obj.toHex());
+
+console.log('Decoded:');
+console.log(MyStruct.fromHex(obj.toHex()));
+
+console.log('Base64:');
+console.log(obj.toBase64());
+```
+
 ## Contribution and License Agreement
@@ -23,0 +66,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

74278

increased by5.26%

Number of package files

16

increased by6.67%

Lines of code

3138

increased by4.84%

Number of lines in readme file

75

increased by134.38%

No dependency changes