mafintosh

chrisdickinson

varint

  "description": "protobuf-style varint bytes - use msb to create integer values of varying sizes",

    "url": "git://github.com/chrisdickinson/varint.git"

  "author": "Chris Dickinson <chris@neversaw.us>",

encode whole numbers to an array of [protobuf-style varint bytes](https://developers.google.com/protocol-buffers/docs/encoding#varints) and also decode them.

var bytes = varint.encode(300) // === [0xAC, 0x02]

varint.decode.bytesRead // 2 (the last decode() call required 2 bytes)

varint.decode.bytes // 2 (the last decode() call required 2 bytes)

### varint.encode(num[, output=[], offset=0]) -> array

### varint.encode(num[, buffer=[], offset=0]) -> buffer

encodes `num` into either the array given by `offset` or a new array at `offset`

and returns that array filled with integers.

Encodes `num` into `buffer` starting at `offset`. returns `buffer`, with the encoded varint written into it. If `buffer` is not provided, it will default to a new array.

`varint.encode.bytes` will now be set to the number of bytes

### varint.decode(data[, offset=0]) -> number

decodes `data`, which can be either a buffer or array of integers, from position `offset` or default 0 and returns the decoded original integer.

if you also require the length (number of bytes) that were required to decode the integer you can access it via `varint.decode.bytes`. this is an integer property that will tell you the number of bytes that the last .decode() call had to use to decode.

similar to `decode.bytes` when encoding a number it can be useful to know how many bytes where written (especially if you pass an output array). you can access this via `varint.encode.bytes` which holds the number of bytes written in the last encode.

returns the number of bytes this number will be encoded as, up to a maximum of 8.

If varint is passed a buffer that does not contain a valid end

byte, then `decode` will return undefined, and `decode.bytesRead`

byte, then `decode` will return undefined, and `decode.bytes` 

will be set to 0. If you are reading from a streaming source,

it's okay to pass an incomplete buffer into `decode`, detect this

case, and then concatenate the next buffer.

		{
		"name": "varint",
		"version": "3.0.0",
		"version": "3.0.1",
		"description": "protobuf-style varint bytes - use msb to create integer values of varying sizes",
		@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

Fixed alerts

Improved metrics

		@@ -10,3 +10,3 @@ # varint
		varint.decode(bytes) // 300
		varint.decode.bytesRead // 2 (the last decode() call required 2 bytes)
		varint.decode.bytes // 2 (the last decode() call required 2 bytes)
		```
		@@ -18,7 +18,9 @@

		### varint.encode(num[, output=[], offset=0]) -> array
		### varint.encode(num[, buffer=[], offset=0]) -> buffer

		encodes `num` into either the array given by `offset` or a new array at `offset`
		and returns that array filled with integers.
		Encodes `num` into `buffer` starting at `offset`. returns `buffer`, with the encoded varint written into it. If `buffer` is not provided, it will default to a new array.

		`varint.encode.bytes` will now be set to the number of bytes
		modified.

		### varint.decode(data[, offset=0]) -> number
		@@ -44,3 +46,3 @@
		If varint is passed a buffer that does not contain a valid end
		byte, then `decode` will return undefined, and `decode.bytesRead`
		byte, then `decode` will return undefined, and `decode.bytes`
		will be set to 0. If you are reading from a streaming source,
		@@ -47,0 +49,0 @@ it's okay to pass an incomplete buffer into `decode`, detect this