Streaming access for Node Buffer
A lightweight wrapper around Node's native Buffer implementation, providing continuous read and write operations for various primitive types (uint8 to uint32).
Importing the Module
Initializing a new OctetBuffer
//without any initial contentvar octetBuffer = ;//with hex stringvar hex = 'deadbeef';var octetBuffer = hex;//with existing Buffervar hex = 'deadbeef';var buffer = hex 'hex';var octetBuffer = buffer;
//remaining bytes (or octets if you like) to readvar remaining = octetBufferremaining;//remaining -> 4//current position from where to read or to where to write nextvar position = octetBufferposition;//position -> 0//overall capacity of the backing Buffervar available = octetBufferavailable;//available -> 4
//primitivesvar num = octetBuffer;var num = octetBuffer;var num = octetBuffer;var num = octetBuffer;//specific number of bytesvar num = 10var buffer = octetBuffer;//all remainingvar buffer = octetBuffer;//next byte without incrementing positionvar next = octetBuffer;
Note: If the backing buffer has not enough capacity for the new data, it will be extended.
//primitivesvar num = 22;octetBuffer;octetBuffer;octetBuffer;octetBuffer;//array containing bytesvar array = 0xde 0xad 0xbe 0xef;octetBuffer;//another buffervar buffer = 'deadbeef' 'hex';octetBuffer;
//serializing to hex stringvar hex = octetBuffer;//hex -> 'deadbeef'//resetting position to 0octetBuffer;
The project is build on
DefinitelyTyped for downloading typescript definitions for development dependencies. In the end, everything is glued together by
npm install gulp -gnpm install typescript -gnpm install tsd -g
The MIT License (MIT) Copyright (c) 2015 Simon Eumes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.