Blame view
node_modules/bops/README.md
2.01 KB
f7563de62
first commit
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# bops
buffer/typed array agnostic buffer operations.
```javascript
var binary = require('bops')
binary.readUInt8(new Buffer(10), 0) // === 10
```
in browser, will default to using `Uint8Array` instances.
in node, will default to using `Buffer` instances.
## API
> ## supported encodings
> * utf8
> * hex
> * base64
#### bops.from(str, encoding="utf8") -> buf
given a string (and optional encoding) return a native buffer instance.
also accepts arrays.
#### bops.to(buf, encoding="utf8") -> str
given a native buffer (and optional encoding) return a string.
#### bops.is(buf) -> bool
given a native buffer returns true. Returns false for other values.
#### bops.subarray(buf, start[, end]) -> buf
return a view onto the original buffer.
#### bops.join([buf, buf, buf]) -> buf
compile several buffers into a single buffer.
#### bops.create(size) -> buf
create a native buffer instance of `size`.
#### bops.copy(source, target, target_start, source_start, source_end)
perform a fast copy from one native buffer to another.
#### readUInt8(buf, at)
#### readInt8(buf, at)
#### readUInt16LE(buf, at)
#### readUInt32LE(buf, at)
#### readInt8(buf, at)
#### readInt16LE(buf, at)
#### readInt32LE(buf, at)
#### readFloatLE(buf, at)
#### readDoubleLE(buf, at)
#### readUInt16BE(buf, at)
#### readUInt32BE(buf, at)
#### readInt16BE(buf, at)
#### readInt32BE(buf, at)
#### readFloatBE(buf, at)
#### readDoubleBE(buf, at)
read a value from a buffer at a given byte offset.
#### writeUInt8(buf, value, at)
#### writeInt8(buf, value, at)
#### writeUInt16LE(buf, value, at)
#### writeUInt32LE(buf, value, at)
#### writeInt8(buf, value, at)
#### writeInt16LE(buf, value, at)
#### writeInt32LE(buf, value, at)
#### writeFloatLE(buf, value, at)
#### writeDoubleLE(buf, value, at)
#### writeUInt16BE(buf, value, at)
#### writeUInt32BE(buf, value, at)
#### writeInt16BE(buf, value, at)
#### writeInt32BE(buf, value, at)
#### writeFloatBE(buf, value, at)
#### writeDoubleBE(buf, value, at)
write a value to a buffer at a given byte offset.
# License
MIT
|