Skip to content

README.md

Latest commit

 

History

History
54 lines (41 loc) · 1.9 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.9 KB
Raw

@escodb/buffer

A browser-compatible implementation of a subset of the Node.js Buffer API. This package implements only the methods needed by EscoDB and is thus a lot smaller than other Buffer implementations. We use Buffer as it provides a few more conveniences compared to the Uint8Array interface, but since Buffer extends Uint8Array you can use all the typed array methods on a Buffer instance.

Installation

npm install @escodb/buffer

Usage

Import the Buffer class as follows:

const { Buffer } = require('@escodb/buffer')

This will return the native Buffer class on Node.js, and our own implementation in browser environments.

The Buffer methods listed below are implemented, and should work identically to their Node.js versions with the following known caveats:

  • The supported encodings are base64, hex and utf8, and no others.
  • The readIntBE(), readIntLE(), readUIntBE(), readUIntLE(), writeIntBE(), writeIntLE(), writeUIntBE() and writeUIntLE() methods accept a maximum byteLength value of 4.

Supported methods:

  • Buffer.alloc(size)
  • Buffer.compare(buf1, buf2)
  • Buffer.concat(list[, totalLength])
  • Buffer.from(object[, encoding])
  • Buffer.isBuffer(object)
  • Buffer.isEncoding(encoding)
  • buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])
  • buf.copy(target[, targetStart[, sourceStart[, sourceEnd]]])
  • buf.equals(target)
  • buf.readBig[U]Int64{BE,LE}([offset])
  • buf.read[U]Int{8,{16,32}{BE,LE}}([offset])
  • buf.read[U]Int{BE,LE}(offset, byteLength)
  • buf.toString([encoding])
  • buf.writeBig[U]Int64{BE,LE}(value[, offset])
  • buf.write[U]Int{8,{16,32}{BE,LE}}(value[, offset])
  • buf.write[U]Int{BE,LE}(value, offset, byteLength)