node_modules/buffer-xor/README.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

buffer-xor

A simple module for bitwise-xor on buffers.

Examples

var xor = require("buffer-xor")
var a = new Buffer('00ff0f', 'hex')
var b = new Buffer('f0f0', 'hex')

console.log(xor(a, b))
// => <Buffer f0 0f>

Or for those seeking those few extra cycles, perform the operation in place:

var xorInplace = require("buffer-xor/inplace")
var a = new Buffer('00ff0f', 'hex')
var b = new Buffer('f0f0', 'hex')

console.log(xorInplace(a, b))
// => <Buffer f0 0f>
// NOTE: xorInplace will return the shorter slice of its parameters

// See that a has been mutated
console.log(a)
// => <Buffer f0 0f 0f>

License MIT

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.