New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

clever-buffer

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

clever-buffer - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

src/clever-buffer-common.js
src/clever-buffer-reader.js
src/clever-buffer-writer.js
src/clever-buffer.js
src/defaults.js

21

package.json
{
"name": "clever-buffer",
"version": "2.1.0",
"version": "3.0.0",
"description": "Buffer utilities",

@@ -9,24 +9,21 @@ "author": "Tabcorp Digital Technology Team",

"type": "git",
"url": "https://github.com/TabDigital/clever-buffer.git"
"url": "https://github.com/Tabcorp/clever-buffer.git"
},
"bugs": {
"url": "https://github.com/TabDigital/clever-buffer/issues"
"url": "https://github.com/Tabcorp/clever-buffer/issues"
},
"main": "target/clever-buffer.js",
"main": "src/clever-buffer.js",
"scripts": {
"test": "mocha",
"compile": "coffee --output target --compile src",
"prepublish": "npm test && npm run compile"
"test": "mocha \"test/**/*.js\"",
"prepublish": "npm test"
},
"//": "there is a known issue with ref:1.3.5 and certain versions of node",
"dependencies": {
"ref": "1.3.4"
"ref-napi": "1.4.2"
},
"devDependencies": {
"cli-table": "^0.3.1",
"coffee-script": "~1.12.6",
"lodash": "^4.17.11",
"mocha": "~5.2.0",
"lodash": "^4.17.15",
"mocha": "~6.2.2",
"should": "~13.2.1"
}
}

240

README.md

@@ -17,10 +17,10 @@ # clever-buffer

* One time specification of endian-ness and whether to assert on buffer length
* 64 bit integer support. We use [ref](https://github.com/TooTallNate/ref) under the hood for our 64 bit numbers
* 64 bit integer support. We use [ref](https://github.com/node-ffi-napi/ref-napi) under the hood for our 64 bit numbers
## Installation
``` coffee
``` js
npm install clever-buffer
```
_NOTE_: Examples below in coffeescript
_NOTE_: Examples below in javascript

@@ -30,4 +30,4 @@ ## Reader Usage

#### Requiring the reader in your project
```coffee
{ CleverBufferReader } = require 'clever-buffer'
``` js
{ CleverBufferReader } = require('clever-buffer');
```

@@ -43,4 +43,4 @@

Allocates a new CleverBufferReader with an internal buffer of the specified existingBuffer
``` coffee
reader = new CleverBufferReader existingBuffer, {offset:0, noAssert: true, bigEndian: false}
``` js
var reader = new CleverBufferReader(existingBuffer, { offset: 0, noAssert: true, bigEndian: false});
```

@@ -53,7 +53,7 @@

``` coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
console.log reader.getUInt8() # 255
console.log reader.getUInt8() # 2
``` js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt8()); // 255
console.log(reader.getUInt8()); // 2
```

@@ -66,7 +66,7 @@

``` coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
console.log reader.getInt8() # -1
console.log reader.getInt8() # 2
``` js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt8()); // -1
console.log(reader.getInt8()); // 2
```

@@ -79,7 +79,7 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0x02, 0x00]
reader = new CleverBufferReader buf
console.log reader.getUInt16() # 65535
console.log reader.getUInt16() # 2
``` js
var buf = Buffer.from([0xFF, 0xFF, 0x02, 0x00]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt16()); // 65535
console.log(reader.getUInt16()); // 2
```

@@ -92,7 +92,7 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0x02, 0x00]
reader = new CleverBufferReader buf
console.log reader.getInt16() # -1
console.log reader.getInt16() # 2
```js
var buf = Buffer.from([0xFF, 0xFF, 0x02, 0x00]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt16()); # -1
console.log(reader.getInt16()); # 2
```

@@ -105,6 +105,6 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0xFF, 0xFF]
reader = new CleverBufferReader buf
console.log reader.getUInt32() # 4294967295
``` js
var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt32()); // 4294967295
```

@@ -117,6 +117,6 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0xFF, 0xFF]
reader = new CleverBufferReader buf
console.log reader.getInt32() # -1
``` js
var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt32()); // -1
```

@@ -132,6 +132,6 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]
reader = new CleverBufferReader buf
console.log reader.getUInt64() # "18446744073709551615"
```js
var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getUInt64()); // "18446744073709551615"
```

@@ -147,6 +147,6 @@

``` coffee
buf = new Buffer [0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]
reader = new CleverBufferReader buf
console.log reader.getInt64() # "-1"
```js
var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF,0xFF, 0xFF, 0xFF, 0xFF]);
var reader = new CleverBufferReader(buf);
console.log(reader.getInt64()); // "-1"
```

@@ -162,6 +162,6 @@

``` coffee
buf = new Buffer [0x48, 0x45, 0x4C, 0x4C, 0x4F]
reader = new CleverBufferReader buf
console.log reader.getString(length:5) # "HELLO"
```js
var buf = Buffer.from([0x48, 0x45, 0x4C, 0x4C, 0x4F]);
var reader = new CleverBufferReader(buf);
console.log(reader.getString(length: 5)); // "HELLO"
```

@@ -172,4 +172,4 @@

#### Requiring the writer in your project
```coffee
{ CleverBufferWriter } = require 'clever-buffer'
```js
{ CleverBufferWriter } = require('clever-buffer');
```

@@ -185,4 +185,4 @@

Allocates a new CleverBufferWriter with an internal buffer of the specified existingBuffer
``` coffee
writer = new CleverBufferWriter existingBuffer, {offset:0, noAssert: true, bigEndian: false}
```js
var writer = new CleverBufferWriter(existingBuffer, {offset: 0, noAssert: true, bigEndian: false});
```

@@ -196,8 +196,8 @@

``` coffee
buf = new Buffer 2
writer = new CleverBufferWriter buf
writer.writeUInt8 255
writer.writeUInt8 2
console.log buf # [0xFF, 0x02]
```js
var buf = Buffer.alloc(2);
var writer = new CleverBufferWriter(buf);
writer.writeUInt8(255);
writer.writeUInt8(2);
console.log(buf); // [0xFF, 0x02]
```

@@ -211,8 +211,8 @@

``` coffee
buf = new Buffer 2
writer = new CleverBufferWriter buf
writer.writeInt8 -1
writer.writeInt8 2
console.log buf # [0xFF, 0x02]
```js
var buf = Buffer.alloc(2);
var writer = new CleverBufferWriter(buf);
writer.writeInt8(-1);
writer.writeInt8(2);
console.log(buf); // [0xFF, 0x02]
```

@@ -226,8 +226,8 @@

``` coffee
buf = new Buffer 4
writer = new CleverBufferWriter buf
writer.writeUInt16 65535
writer.writeUInt16 2
console.log buf # [0xFF, 0xFF, 0x02, 0x00]
```js
var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeUInt16(65535);
writer.writeUInt16(2);
console.log(buf); // [0xFF, 0xFF, 0x02, 0x00]
```

@@ -241,8 +241,8 @@

``` coffee
buf = new Buffer 4
writer = new CleverBufferWriter buf
writer.writeInt16 -1
writer.writeInt16 2
console.log buf # [0xFF, 0xFF, 0x02, 0x00]
```js
buf = Buffer.alloc(4);
writer = new CleverBufferWriter(buf);
writer.writeInt16(-1);
writer.writeInt16(2);
console.log(buf); // [0xFF, 0xFF, 0x02, 0x00]
```

@@ -255,7 +255,7 @@ #### writer.writeUInt32(value, [offset])

``` coffee
buf = new Buffer 4
writer = new CleverBufferWriter buf
writer.writeUInt32 4294967295
console.log buf # [0xFF, 0xFF, 0xFF, 0xFF]
```js
var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeUInt32(4294967295);
console.log(buf); // [0xFF, 0xFF, 0xFF, 0xFF]
```

@@ -269,7 +269,7 @@

``` coffee
buf = new Buffer 4
writer = new CleverBufferWriter buf
writer.writeInt32 -1
console.log buf # [0xFF, 0xFF, 0xFF, 0xFF]
```js
var buf = Buffer.alloc(4);
var writer = new CleverBufferWriter(buf);
writer.writeInt32(-1);
console.log(buf); // [0xFF, 0xFF, 0xFF, 0xFF]
```

@@ -286,7 +286,7 @@ #### writer.writeString(value, [options])

``` coffee
buf = new Buffer 8
writer = new CleverBufferWriter buf
len = writer.writeString "héllo"
console.log len, buf # 6, [0x68, 0xc3, 0xa9, 0x6c, 0x6c, 0x6f, 0x00, 0x00]
```js
var buf = Buffer.alloc(8);
var writer = new CleverBufferWriter(buf);
var len = writer.writeString("héllo");
console.log(len, buf); // 6, [0x68, 0xc3, 0xa9, 0x6c, 0x6c, 0x6f, 0x00, 0x00]
```

@@ -299,10 +299,10 @@

Gets the current offset of the buffer
```coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
console.log reader.getOffset() # 0
reader.getUInt8()
console.log reader.getOffset() # 1
reader.getUInt8()
console.log reader.getOffset() # 2
```js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.getUInt8();
console.log(reader.getOffset()); // 1
reader.getUInt8();
console.log(reader.getOffset()); // 2
```

@@ -315,8 +315,8 @@

```coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
console.log reader.getOffset() # 0
reader.skip 2
console.log reader.getOffset() # 2
```js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.skip(2);
console.log(reader.getOffset()); // 2
```

@@ -329,8 +329,8 @@

```coffee
buf = new Buffer [0xFF, 0xFF, 0xFF, 0x01]
reader = new CleverBufferReader buf
console.log reader.getOffset() # 0
reader.skipTo 3
console.log reader.getOffset() # 3
```js
var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0x01]);
var reader = new CleverBufferReader(buf);
console.log(reader.getOffset()); // 0
reader.skipTo(3);
console.log(reader.getOffset()); // 3
```

@@ -341,6 +341,6 @@

```coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
console.log reader.getBuffer()[1] # 2
```js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
console.log(reader.getBuffer()[1]); // 2
```

@@ -351,8 +351,8 @@

```coffee
buf = new Buffer [0xFF, 0x02]
reader = new CleverBufferReader buf
reader.getUInt8()
console.log reader.trim() # [0xFF]
console.log buf # [0xFF, 0x02]
```js
var buf = Buffer.from([0xFF, 0x02]);
var reader = new CleverBufferReader(buf);
reader.getUInt8();
console.log(reader.trim()); // [0xFF]
console.log(buf); // [0xFF, 0x02]
```

@@ -359,0 +359,0 @@ 

target/clever-buffer-common.js
target/clever-buffer-reader.js
target/clever-buffer-writer.js
target/clever-buffer.js
target/defaults.js
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc