Breaking Changes in v4.0

Looking for v3 docs?

Installing:

Using smart-buffer

Simple Example

Write vs Insert

Constructing a smart-buffer

Api Reference:

Constructing

constructor()

constructor([options])

Class Method: fromBuffer(buffer[, encoding])

Class Method: fromSize(size[, encoding])

Class Method: fromOptions(options)

Integers

buff.readInt8([offset])

buff.readUInt8([offset])

buff.readInt16BE([offset])

buff.readInt16LE([offset])

buff.readUInt16BE([offset])

buff.readUInt16LE([offset])

buff.readInt32BE([offset])

buff.readInt32LE([offset])

buff.readUInt32BE([offset])

buff.readUInt32LE([offset])

buff.writeInt8(value[, offset])

buff.writeUInt8(value[, offset])

buff.insertInt8(value, offset)

buff.insertUInt8(value, offset)

buff.writeInt16BE(value[, offset])

buff.writeInt16LE(value[, offset])

buff.writeUInt16BE(value[, offset])

buff.writeUInt16LE(value[, offset])

buff.insertInt16BE(value, offset)

buff.insertInt16LE(value, offset)

buff.insertUInt16BE(value, offset)

buff.insertUInt16LE(value, offset)

buff.writeInt32BE(value[, offset])

buff.writeInt32LE(value[, offset])

buff.writeUInt32BE(value[, offset])

buff.writeUInt32LE(value[, offset])

buff.insertInt32BE(value, offset)

buff.insertInt32LE(value, offset)

buff.insertUInt32BE(value, offset)

buff.nsertUInt32LE(value, offset)

Floating Point Numbers

buff.readFloatBE([offset])

buff.readFloatLE([offset])

buff.readDoubleBE([offset])

buff.readDoubleLE([offset])

buff.writeFloatBE(value[, offset])

buff.writeFloatLE(value[, offset])

buff.insertFloatBE(value, offset)

buff.insertFloatLE(value, offset)

buff.writeDoubleBE(value[, offset])

buff.writeDoubleLE(value[, offset])

buff.insertDoubleBE(value, offset)

buff.insertDoubleLE(value, offset)

Strings

buff.readString()

buff.readString(size[, encoding])

buff.readString(encoding)

buff.writeString(value)

buff.writeString(value[, offset])

buff.writeString(value[, encoding])

buff.writeString(value[, offset[, encoding]])

buff.insertString(value, offset[, encoding])

Null Terminated Strings

buff.readStringNT()

buff.readStringNT(encoding)

buff.writeStringNT(value)

buff.writeStringNT(value[, offset])

buff.writeStringNT(value[, encoding])

buff.writeStringNT(value[, offset[, encoding]])

buff.insertStringNT(value, offset[, encoding])

Buffers

buff.readBuffer([length])

buff.writeBuffer(value[, offset])

buff.insertBuffer(value, offset)

buff.readBufferNT()

buff.writeBufferNT(value[, offset])

buff.insertBufferNT(value, offset)

Offsets

buff.readOffset

buff.readOffset(offset)

buff.writeOffset

buff.writeOffset(offset)

buff.encoding

buff.encoding(encoding)

Other

buff.clear()

buff.remaining()

buff.internalBuffer

buff.toBuffer()

buff.toString([encoding])

buff.destroy()

License