Add more tests and docs.

Author: ginkgoch

README.md

@@ -1,67 +1,102 @@
-# Ginkgoch Buffer Reader for NodeJS
-This is a NodeJS library to help to read [Buffer](https://cn.nodejs.org/api/buffer.html) instance easily.
+# Ginkgoch Buffer IO for NodeJS
+This is a NodeJS library to help to read/write [Buffer](https://cn.nodejs.org/api/buffer.html) instance easily.
 
 ## Install
 ```terminal
-npm i ginkgoch-buffer-reader --save
+npm i ginkgoch-buffer-io --save
 ```
 
 ## Test
 ```terminal
 npm test
 ```
 
-## Example
+## BufferReader Example
 
-**Prepare for data**
+**Without `Ginkgoch Buffer I/O`**
 ```js
-const buffer = Buffer.alloc(4);
+const buffer = Buffer.alloc(16);
 buffer.writeInt8(8, 0);
 buffer.writeInt16LE(16, 1);
 buffer.writeUInt32LE(32, 3);
 buffer.writeDoubleBE(54.8765, 7);
-```
 
-**Without `Ginkgoch Buffer Reader`**
-```js
 let i1 = buffer.readInt8(0);
 let i2 = buffer.readInt16LE(1);
 let i3 = buffer.readUInt32LE(3);
 let i4 = buffer.readDoubleBE(7);
 ```
 
-**With `Ginkgoch Buffer Reader`**
+**With `Ginkgoch Buffer I/O`**
 It automatically manages the read position for you. You don't need to remember the position and the boring type length calculations.
 ```js
-const BufferReader = require('ginkgoch-buffer-reader');
-let br = new BufferReader(buffer);
+const { BufferReader, BufferWriter } = require('ginkgoch-buffer-io');
+
+const buffer = Buffer.alloc(16);
+const bw = new BufferWriter(buffer);
+bw.writeInt8(8);
+bw.writeInt16(16);
+bw.writeUInt32(32);
+bw.writeDoubleBE(54.8765);
+
+const br = new BufferReader(buffer);
 let i1 = br.nextInt8();
-let i2 = br.nextInt16LE();
-let i3 = br.nextUInt32LE();
+let i2 = br.nextInt16();
+let i3 = br.nextUInt32();
 let i4 = br.nextDoubleBE();
 ```
 
-## API
-```js
-constructor(buffer: Buffer);
-seek(offset: number, fromBeginning = true);
-nextBuffer(length: number);
-nextString(length: number, encoding = 'utf-8');
-nextIn8();
-nextUInt8();
-nextUInt16LE();
-nextUInt16BE();
-nextInt16LE();
-nextInt16BE();
-nextUInt32LE();
-nextUInt32BE();
-nextInt32LE();
-nextInt32BE();
-nextFloatLE();
-nextFloatBE();
-nextDoubleLE();
-nextDoubleBE();
-```
+## BufferReader
+* constructor(buffer: Buffer)
+* seek(offset: number, fromBeginning = true)
+* nextBuffer(length: number)
+* nextString(length: number, encoding = 'utf-8')
+* nextInt8()
+* nextUInt8()
+* nextUInt16()
+* nextUInt16LE()
+* nextUInt16BE()
+* nextInt16()
+* nextInt16LE()
+* nextInt16BE()
+* nextUInt32()
+* nextUInt32LE()
+* nextUInt32BE()
+* nextInt32()
+* nextInt32LE()
+* nextInt32BE()
+* nextFloat()
+* nextFloatLE()
+* nextFloatBE()
+* nextDouble()
+* nextDoubleLE()
+* nextDoubleBE()
+
+## BufferWriter
+* constructor(buffer: Buffer)
+* seek(offset: number[, fromBeginning = true])
+* writeBuffer(length: number)
+* writeString(length: number[, encoding = 'utf-8'])
+* writeInt8()
+* writeUInt8()
+* writeUInt16()
+* writeUInt16LE()
+* writeUInt16BE()
+* writeInt16()
+* writeInt16LE()
+* writeInt16BE()
+* writeUInt32()
+* writeUInt32LE()
+* writeUInt32BE()
+* writeInt32()
+* writeInt32LE()
+* writeInt32BE()
+* writeFloat()
+* writeFloatLE()
+* writeFloatBE()
+* writeDouble()
+* writeDoubleLE()
+* writeDoubleBE()
 
 ## Issues
 Contact [ginkgoch@outlook.com](mailto:ginkgoch@outlook.com) or [sumbit an issue](https://github.com/ginkgoch/node-buffer-reader/issues).

index.js

@@ -1,3 +1,4 @@
 const BufferReader = require('./src/reader')
+const BufferWriter = require('./src/writer')
 
-module.exports = { BufferReader }
+module.exports = { BufferReader, BufferWriter }

src/reader.test.js

@@ -1,4 +1,4 @@
-const BufferReader = require('./reader.js');
+const { BufferReader } = require('../index');
 
 describe('buffer reader tests', () => {
     test('init test - normal', () => {

src/writer.test.js

@@ -1,4 +1,4 @@
-const BufferWriter = require('./writer')
+const { BufferWriter, BufferReader } = require('../index')
 
 describe('BufferWriter tests', () => {
 
@@ -34,4 +34,38 @@ describe('BufferWriter tests', () => {
         expect(bufferConcat.length).toBe(12)
         expect(Buffer.compare(bufferSlice, bufferConcat)).toBeTruthy()
     })
+
+    it('demo 1', () => {
+        const buffer = Buffer.alloc(256)
+        const bufferWriter = new BufferWriter(buffer)
+        bufferWriter.writeDouble(12.5)
+        bufferWriter.writeDouble(67.7)
+
+        const bufferReader = new BufferReader(buffer)
+        let value = bufferReader.nextDouble()
+        expect(value).toBe(12.5)
+
+        value = bufferReader.nextDouble()
+        expect(value).toBe(67.7)
+    })
+
+    it('demo 2', () => {
+        const buffer = Buffer.alloc(16);
+        const bw = new BufferWriter(buffer);
+        bw.writeInt8(8);
+        bw.writeInt16(16);
+        bw.writeUInt32(32);
+        bw.writeDoubleBE(54.8765);
+
+        const br = new BufferReader(buffer);
+        let i1 = br.nextInt8();
+        let i2 = br.nextInt16();
+        let i3 = br.nextUInt32();
+        let i4 = br.nextDoubleBE();
+
+        expect(i1).toBe(8)
+        expect(i2).toBe(16)
+        expect(i3).toBe(32)
+        expect(i4).toBe(54.8765)
+    })
 })