smart-buffer
Advanced tools
Comparing version 4.0.1 to 4.0.2
@@ -10,6 +10,6 @@ "use strict"; | ||
/** | ||
* Creates a new SmartBuffer instance. | ||
* | ||
* @param options { SmartBufferOptions } The SmartBufferOptions to apply to this instance. | ||
*/ | ||
* Creates a new SmartBuffer instance. | ||
* | ||
* @param options { SmartBufferOptions } The SmartBufferOptions to apply to this instance. | ||
*/ | ||
constructor(options) { | ||
@@ -59,9 +59,9 @@ this.length = 0; | ||
/** | ||
* Creates a new SmartBuffer instance with the provided internal Buffer size and optional encoding. | ||
* | ||
* @param size { Number } The size of the internal Buffer. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided internal Buffer size and optional encoding. | ||
* | ||
* @param size { Number } The size of the internal Buffer. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
static fromSize(size, encoding) { | ||
@@ -74,9 +74,9 @@ return new this({ | ||
/** | ||
* Creates a new SmartBuffer instance with the provided Buffer and optional encoding. | ||
* | ||
* @param buffer { Buffer } The Buffer to use as the internal Buffer value. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided Buffer and optional encoding. | ||
* | ||
* @param buffer { Buffer } The Buffer to use as the internal Buffer value. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
static fromBuffer(buff, encoding) { | ||
@@ -89,6 +89,6 @@ return new this({ | ||
/** | ||
* Creates a new SmartBuffer instance with the provided SmartBufferOptions options. | ||
* | ||
* @param options { SmartBufferOptions } The options to use when creating the SmartBuffer instance. | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided SmartBufferOptions options. | ||
* | ||
* @param options { SmartBufferOptions } The options to use when creating the SmartBuffer instance. | ||
*/ | ||
static fromOptions(options) { | ||
@@ -98,15 +98,16 @@ return new this(options); | ||
/** | ||
* Type checking function that determines if an object is a SmartBufferOptions object. | ||
*/ | ||
* Type checking function that determines if an object is a SmartBufferOptions object. | ||
*/ | ||
static isSmartBufferOptions(options) { | ||
const castOptions = options; | ||
return castOptions && (castOptions.encoding !== undefined || castOptions.size !== undefined || castOptions.buff !== undefined); | ||
return (castOptions && | ||
(castOptions.encoding !== undefined || castOptions.size !== undefined || castOptions.buff !== undefined)); | ||
} | ||
// Signed integers | ||
/** | ||
* Reads an Int8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt8(offset) { | ||
@@ -116,7 +117,7 @@ return this._readNumberValue(Buffer.prototype.readInt8, 1, offset); | ||
/** | ||
* Reads an Int16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt16BE(offset) { | ||
@@ -126,7 +127,7 @@ return this._readNumberValue(Buffer.prototype.readInt16BE, 2, offset); | ||
/** | ||
* Reads an Int16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt16LE(offset) { | ||
@@ -136,7 +137,7 @@ return this._readNumberValue(Buffer.prototype.readInt16LE, 2, offset); | ||
/** | ||
* Reads an Int32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt32BE(offset) { | ||
@@ -146,7 +147,7 @@ return this._readNumberValue(Buffer.prototype.readInt32BE, 4, offset); | ||
/** | ||
* Reads an Int32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt32LE(offset) { | ||
@@ -156,9 +157,9 @@ return this._readNumberValue(Buffer.prototype.readInt32LE, 4, offset); | ||
/** | ||
* Writes an Int8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt8(value, offset) { | ||
@@ -169,116 +170,107 @@ this._writeNumberValue(Buffer.prototype.writeInt8, 1, value, offset); | ||
/** | ||
* Inserts an Int8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt8(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeInt8, 1, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeInt8, 1, value, offset); | ||
} | ||
/** | ||
* Writes an Int16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt16BE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeInt16BE, 2, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeInt16BE, 2, value, offset); | ||
} | ||
/** | ||
* Inserts an Int16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt16BE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeInt16BE, 2, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeInt16BE, 2, value, offset); | ||
} | ||
/** | ||
* Writes an Int16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt16LE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeInt16LE, 2, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeInt16LE, 2, value, offset); | ||
} | ||
/** | ||
* Inserts an Int16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt16LE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeInt16LE, 2, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeInt16LE, 2, value, offset); | ||
} | ||
/** | ||
* Writes an Int32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt32BE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeInt32BE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeInt32BE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts an Int32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt32BE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeInt32BE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeInt32BE, 4, value, offset); | ||
} | ||
/** | ||
* Writes an Int32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt32LE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeInt32LE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeInt32LE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts an Int32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt32LE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeInt32LE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeInt32LE, 4, value, offset); | ||
} | ||
// Unsigned Integers | ||
/** | ||
* Reads an UInt8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt8(offset) { | ||
@@ -288,7 +280,7 @@ return this._readNumberValue(Buffer.prototype.readUInt8, 1, offset); | ||
/** | ||
* Reads an UInt16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt16BE(offset) { | ||
@@ -298,7 +290,7 @@ return this._readNumberValue(Buffer.prototype.readUInt16BE, 2, offset); | ||
/** | ||
* Reads an UInt16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt16LE(offset) { | ||
@@ -308,7 +300,7 @@ return this._readNumberValue(Buffer.prototype.readUInt16LE, 2, offset); | ||
/** | ||
* Reads an UInt32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt32BE(offset) { | ||
@@ -318,7 +310,7 @@ return this._readNumberValue(Buffer.prototype.readUInt32BE, 4, offset); | ||
/** | ||
* Reads an UInt32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt32LE(offset) { | ||
@@ -328,128 +320,118 @@ return this._readNumberValue(Buffer.prototype.readUInt32LE, 4, offset); | ||
/** | ||
* Writes an UInt8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt8(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeUInt8, 1, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeUInt8, 1, value, offset); | ||
} | ||
/** | ||
* Inserts an UInt8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt8(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeUInt8, 1, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeUInt8, 1, value, offset); | ||
} | ||
/** | ||
* Writes an UInt16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt16BE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeUInt16BE, 2, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeUInt16BE, 2, value, offset); | ||
} | ||
/** | ||
* Inserts an UInt16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt16BE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeUInt16BE, 2, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeUInt16BE, 2, value, offset); | ||
} | ||
/** | ||
* Writes an UInt16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt16LE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeUInt16LE, 2, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeUInt16LE, 2, value, offset); | ||
} | ||
/** | ||
* Inserts an UInt16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt16LE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeUInt16LE, 2, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeUInt16LE, 2, value, offset); | ||
} | ||
/** | ||
* Writes an UInt32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt32BE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeUInt32BE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeUInt32BE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts an UInt32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt32BE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeUInt32BE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeUInt32BE, 4, value, offset); | ||
} | ||
/** | ||
* Writes an UInt32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt32LE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeUInt32LE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeUInt32LE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts an UInt32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt32LE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeUInt32LE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeUInt32LE, 4, value, offset); | ||
} | ||
// Floating Point | ||
/** | ||
* Reads an FloatBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an FloatBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readFloatBE(offset) { | ||
@@ -459,7 +441,7 @@ return this._readNumberValue(Buffer.prototype.readFloatBE, 4, offset); | ||
/** | ||
* Reads an FloatLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an FloatLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readFloatLE(offset) { | ||
@@ -469,56 +451,52 @@ return this._readNumberValue(Buffer.prototype.readFloatLE, 4, offset); | ||
/** | ||
* Writes a FloatBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a FloatBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeFloatBE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeFloatBE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeFloatBE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts a FloatBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a FloatBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertFloatBE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeFloatBE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeFloatBE, 4, value, offset); | ||
} | ||
/** | ||
* Writes a FloatLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a FloatLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeFloatLE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeFloatLE, 4, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeFloatLE, 4, value, offset); | ||
} | ||
/** | ||
* Inserts a FloatLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a FloatLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertFloatLE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeFloatLE, 4, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeFloatLE, 4, value, offset); | ||
} | ||
// Double Floating Point | ||
/** | ||
* Reads an DoublEBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an DoublEBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readDoubleBE(offset) { | ||
@@ -528,7 +506,7 @@ return this._readNumberValue(Buffer.prototype.readDoubleBE, 8, offset); | ||
/** | ||
* Reads an DoubleLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an DoubleLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readDoubleLE(offset) { | ||
@@ -538,59 +516,55 @@ return this._readNumberValue(Buffer.prototype.readDoubleLE, 8, offset); | ||
/** | ||
* Writes a DoubleBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a DoubleBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeDoubleBE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeDoubleBE, 8, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeDoubleBE, 8, value, offset); | ||
} | ||
/** | ||
* Inserts a DoubleBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a DoubleBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertDoubleBE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeDoubleBE, 8, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeDoubleBE, 8, value, offset); | ||
} | ||
/** | ||
* Writes a DoubleLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a DoubleLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeDoubleLE(value, offset) { | ||
this._writeNumberValue(Buffer.prototype.writeDoubleLE, 8, value, offset); | ||
return this; | ||
return this._writeNumberValue(Buffer.prototype.writeDoubleLE, 8, value, offset); | ||
} | ||
/** | ||
* Inserts a DoubleLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a DoubleLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertDoubleLE(value, offset) { | ||
this._insertNumberValue(Buffer.prototype.writeDoubleLE, 8, value, offset); | ||
return this; | ||
return this._insertNumberValue(Buffer.prototype.writeDoubleLE, 8, value, offset); | ||
} | ||
// Strings | ||
/** | ||
* Reads a String from the current read position. | ||
* | ||
* @param arg1 { Number | String } The number of bytes to read as a String, or the BufferEncoding to use for | ||
* the string (Defaults to instance level encoding). | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
* Reads a String from the current read position. | ||
* | ||
* @param arg1 { Number | String } The number of bytes to read as a String, or the BufferEncoding to use for | ||
* the string (Defaults to instance level encoding). | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
readString(arg1, encoding) { | ||
@@ -616,8 +590,10 @@ let lengthVal; | ||
/** | ||
* Inserts a String | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param offset { Number } The offset to insert the string at. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Inserts a String | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param offset { Number } The offset to insert the string at. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
insertString(value, offset, encoding) { | ||
@@ -628,8 +604,10 @@ utils_1.checkOffsetValue(offset); | ||
/** | ||
* Writes a String | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Writes a String | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
writeString(value, arg2, encoding) { | ||
@@ -639,8 +617,8 @@ return this._handleString(value, false, arg2, encoding); | ||
/** | ||
* Reads a null-terminated String from the current read position. | ||
* | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
* Reads a null-terminated String from the current read position. | ||
* | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
readStringNT(encoding) { | ||
@@ -666,8 +644,10 @@ if (typeof encoding !== 'undefined') { | ||
/** | ||
* Inserts a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Inserts a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
insertStringNT(value, offset, encoding) { | ||
@@ -678,10 +658,13 @@ utils_1.checkOffsetValue(offset); | ||
this.insertUInt8(0x00, offset + value.length); | ||
return this; | ||
} | ||
/** | ||
* Writes a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Writes a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
writeStringNT(value, arg2, encoding) { | ||
@@ -691,11 +674,12 @@ // Write Values | ||
this.writeUInt8(0x00, typeof arg2 === 'number' ? arg2 + value.length : this.writeOffset); | ||
return this; | ||
} | ||
// Buffers | ||
/** | ||
* Reads a Buffer from the internal read position. | ||
* | ||
* @param length { Number } The length of data to read as a Buffer. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
* Reads a Buffer from the internal read position. | ||
* | ||
* @param length { Number } The length of data to read as a Buffer. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
readBuffer(length) { | ||
@@ -714,7 +698,9 @@ if (typeof length !== 'undefined') { | ||
/** | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
insertBuffer(value, offset) { | ||
@@ -725,7 +711,9 @@ utils_1.checkOffsetValue(offset); | ||
/** | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
writeBuffer(value, offset) { | ||
@@ -735,6 +723,6 @@ return this._handleBuffer(value, false, offset); | ||
/** | ||
* Reads a null-terminated Buffer from the current read poisiton. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
* Reads a null-terminated Buffer from the current read poisiton. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
readBufferNT() { | ||
@@ -757,7 +745,9 @@ // Set null character position to the end SmartBuffer instance. | ||
/** | ||
* Inserts a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Inserts a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
insertBufferNT(value, offset) { | ||
@@ -771,7 +761,9 @@ utils_1.checkOffsetValue(offset); | ||
/** | ||
* Writes a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
writeBufferNT(value, offset) { | ||
@@ -788,4 +780,4 @@ // Checks for valid numberic value; | ||
/** | ||
* Clears the SmartBuffer instance to its original empty state. | ||
*/ | ||
* Clears the SmartBuffer instance to its original empty state. | ||
*/ | ||
clear() { | ||
@@ -798,6 +790,6 @@ this._writeOffset = 0; | ||
/** | ||
* Gets the remaining data left to be read from the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the remaining data left to be read from the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
remaining() { | ||
@@ -807,6 +799,6 @@ return this.length - this._readOffset; | ||
/** | ||
* Gets the current read offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the current read offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
get readOffset() { | ||
@@ -816,6 +808,6 @@ return this._readOffset; | ||
/** | ||
* Sets the read offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
* Sets the read offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
set readOffset(offset) { | ||
@@ -828,6 +820,6 @@ utils_1.checkOffsetValue(offset); | ||
/** | ||
* Gets the current write offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the current write offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
get writeOffset() { | ||
@@ -837,6 +829,6 @@ return this._writeOffset; | ||
/** | ||
* Sets the write offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
* Sets the write offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
set writeOffset(offset) { | ||
@@ -849,6 +841,6 @@ utils_1.checkOffsetValue(offset); | ||
/** | ||
* Gets the currently set string encoding of the SmartBuffer instance. | ||
* | ||
* @return { BufferEncoding } The string Buffer encoding currently set. | ||
*/ | ||
* Gets the currently set string encoding of the SmartBuffer instance. | ||
* | ||
* @return { BufferEncoding } The string Buffer encoding currently set. | ||
*/ | ||
get encoding() { | ||
@@ -858,6 +850,6 @@ return this._encoding; | ||
/** | ||
* Sets the string encoding of the SmartBuffer instance. | ||
* | ||
* @param encoding { BufferEncoding } The string Buffer encoding to set. | ||
*/ | ||
* Sets the string encoding of the SmartBuffer instance. | ||
* | ||
* @param encoding { BufferEncoding } The string Buffer encoding to set. | ||
*/ | ||
set encoding(encoding) { | ||
@@ -868,6 +860,6 @@ utils_1.checkEncoding(encoding); | ||
/** | ||
* Gets the underlying internal Buffer. (This includes unmanaged data in the Buffer) | ||
* | ||
* @return { Buffer } The Buffer value. | ||
*/ | ||
* Gets the underlying internal Buffer. (This includes unmanaged data in the Buffer) | ||
* | ||
* @return { Buffer } The Buffer value. | ||
*/ | ||
get internalBuffer() { | ||
@@ -877,6 +869,6 @@ return this._buff; | ||
/** | ||
* Gets the value of the internal managed Buffer (Includes managed data only) | ||
* | ||
* @param { Buffer } | ||
*/ | ||
* Gets the value of the internal managed Buffer (Includes managed data only) | ||
* | ||
* @param { Buffer } | ||
*/ | ||
toBuffer() { | ||
@@ -886,6 +878,6 @@ return this._buff.slice(0, this.length); | ||
/** | ||
* Gets the String value of the internal managed Buffer | ||
* | ||
* @param encoding { String } The BufferEncoding to display the Buffer as (defaults to instance level encoding). | ||
*/ | ||
* Gets the String value of the internal managed Buffer | ||
* | ||
* @param encoding { String } The BufferEncoding to display the Buffer as (defaults to instance level encoding). | ||
*/ | ||
toString(encoding) { | ||
@@ -898,4 +890,4 @@ const encodingVal = typeof encoding === 'string' ? encoding : this._encoding; | ||
/** | ||
* Destroys the SmartBuffer instance. | ||
*/ | ||
* Destroys the SmartBuffer instance. | ||
*/ | ||
destroy() { | ||
@@ -906,9 +898,9 @@ this.clear(); | ||
/** | ||
* Handles inserting and writing strings. | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param isInsert { Boolean } True if inserting a string, false if writing. | ||
* @param arg2 { Number | String } The offset to insert the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Handles inserting and writing strings. | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param isInsert { Boolean } True if inserting a string, false if writing. | ||
* @param arg2 { Number | String } The offset to insert the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
_handleString(value, isInsert, arg3, encoding) { | ||
@@ -959,7 +951,7 @@ let offsetVal = this._writeOffset; | ||
/** | ||
* Handles writing or insert of a Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Handles writing or insert of a Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
_handleBuffer(value, isInsert, offset) { | ||
@@ -993,7 +985,7 @@ const offsetVal = typeof offset === 'number' ? offset : this._writeOffset; | ||
/** | ||
* Ensures that the internal Buffer is large enough to read data. | ||
* | ||
* @param length { Number } The length of the data that needs to be read. | ||
* @param offset { Number } The offset of the data that needs to be read. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to read data. | ||
* | ||
* @param length { Number } The length of the data that needs to be read. | ||
* @param offset { Number } The offset of the data that needs to be read. | ||
*/ | ||
ensureReadable(length, offset) { | ||
@@ -1015,7 +1007,7 @@ // Offset value defaults to managed read offset. | ||
/** | ||
* Ensures that the internal Buffer is large enough to insert data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to insert data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written. | ||
*/ | ||
ensureInsertable(dataLength, offset) { | ||
@@ -1039,7 +1031,7 @@ // Checks for valid numberic value; | ||
/** | ||
* Ensures that the internal Buffer is large enough to write data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written (defaults to writeOffset). | ||
*/ | ||
* Ensures that the internal Buffer is large enough to write data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written (defaults to writeOffset). | ||
*/ | ||
_ensureWriteable(dataLength, offset) { | ||
@@ -1055,6 +1047,6 @@ const offsetVal = typeof offset === 'number' ? offset : this._writeOffset; | ||
/** | ||
* Ensures that the internal Buffer is large enough to write at least the given amount of data. | ||
* | ||
* @param minLength { Number } The minimum length of the data needs to be written. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to write at least the given amount of data. | ||
* | ||
* @param minLength { Number } The minimum length of the data needs to be written. | ||
*/ | ||
_ensureCapacity(minLength) { | ||
@@ -1064,3 +1056,3 @@ const oldLength = this._buff.length; | ||
let data = this._buff; | ||
let newLength = oldLength * 3 / 2 + 1; | ||
let newLength = (oldLength * 3) / 2 + 1; | ||
if (newLength < minLength) { | ||
@@ -1074,10 +1066,10 @@ newLength = minLength; | ||
/** | ||
* Reads a numeric number value using the provided function. | ||
* | ||
* @param func { Function(offset: number) => number } The function to read data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes read. | ||
* @param offset { Number } The offset to read from (optional). When this is not provided, the managed readOffset is used instead. | ||
* | ||
* @param { Number } | ||
*/ | ||
* Reads a numeric number value using the provided function. | ||
* | ||
* @param func { Function(offset: number) => number } The function to read data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes read. | ||
* @param offset { Number } The offset to read from (optional). When this is not provided, the managed readOffset is used instead. | ||
* | ||
* @param { Number } | ||
*/ | ||
_readNumberValue(func, byteSize, offset) { | ||
@@ -1094,10 +1086,10 @@ this.ensureReadable(byteSize, offset); | ||
/** | ||
* Inserts a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
* Inserts a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
_insertNumberValue(func, byteSize, value, offset) { | ||
@@ -1112,12 +1104,13 @@ // Check for invalid offset values. | ||
this._writeOffset += byteSize; | ||
return this; | ||
} | ||
/** | ||
* Writes a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
* Writes a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
_writeNumberValue(func, byteSize, value, offset) { | ||
@@ -1145,2 +1138,3 @@ // If an offset was provided, validate it. | ||
} | ||
return this; | ||
} | ||
@@ -1147,0 +1141,0 @@ } |
{ | ||
"name": "smart-buffer", | ||
"version": "4.0.1", | ||
"version": "4.0.2", | ||
"description": "smart-buffer is a Buffer wrapper that adds automatic read & write offset tracking, string operations, data insertions, and more.", | ||
@@ -5,0 +5,0 @@ "main": "build/smartbuffer.js", |
/// <reference types="node" /> | ||
declare module 'smart-buffer' { | ||
/** | ||
/** | ||
* Object interface for constructing new SmartBuffer instances. | ||
*/ | ||
interface SmartBufferOptions { | ||
interface SmartBufferOptions { | ||
encoding?: BufferEncoding; | ||
size?: number; | ||
buff?: Buffer; | ||
} | ||
class SmartBuffer { | ||
} | ||
declare class SmartBuffer { | ||
length: number; | ||
@@ -18,638 +17,632 @@ private _encoding; | ||
/** | ||
* Creates a new SmartBuffer instance. | ||
* | ||
* @param options { SmartBufferOptions } The SmartBufferOptions to apply to this instance. | ||
*/ | ||
* Creates a new SmartBuffer instance. | ||
* | ||
* @param options { SmartBufferOptions } The SmartBufferOptions to apply to this instance. | ||
*/ | ||
constructor(options?: SmartBufferOptions); | ||
/** | ||
* Creates a new SmartBuffer instance with the provided internal Buffer size and optional encoding. | ||
* | ||
* @param size { Number } The size of the internal Buffer. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided internal Buffer size and optional encoding. | ||
* | ||
* @param size { Number } The size of the internal Buffer. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
static fromSize(size: number, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Creates a new SmartBuffer instance with the provided Buffer and optional encoding. | ||
* | ||
* @param buffer { Buffer } The Buffer to use as the internal Buffer value. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided Buffer and optional encoding. | ||
* | ||
* @param buffer { Buffer } The Buffer to use as the internal Buffer value. | ||
* @param encoding { String } The BufferEncoding to use for strings. | ||
* | ||
* @return { SmartBuffer } | ||
*/ | ||
static fromBuffer(buff: Buffer, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Creates a new SmartBuffer instance with the provided SmartBufferOptions options. | ||
* | ||
* @param options { SmartBufferOptions } The options to use when creating the SmartBuffer instance. | ||
*/ | ||
* Creates a new SmartBuffer instance with the provided SmartBufferOptions options. | ||
* | ||
* @param options { SmartBufferOptions } The options to use when creating the SmartBuffer instance. | ||
*/ | ||
static fromOptions(options: SmartBufferOptions): SmartBuffer; | ||
/** | ||
* Type checking function that determines if an object is a SmartBufferOptions object. | ||
*/ | ||
static isSmartBufferOptions( | ||
options: SmartBufferOptions | ||
): options is SmartBufferOptions; | ||
* Type checking function that determines if an object is a SmartBufferOptions object. | ||
*/ | ||
static isSmartBufferOptions(options: SmartBufferOptions): options is SmartBufferOptions; | ||
/** | ||
* Reads an Int8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt8(offset?: number): number; | ||
/** | ||
* Reads an Int16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt16BE(offset?: number): number; | ||
/** | ||
* Reads an Int16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt16LE(offset?: number): number; | ||
/** | ||
* Reads an Int32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt32BE(offset?: number): number; | ||
/** | ||
* Reads an Int32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an Int32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readInt32LE(offset?: number): number; | ||
/** | ||
* Writes an Int8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt8(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an Int8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt8(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an Int16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt16BE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an Int16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt16BE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an Int16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt16LE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an Int16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt16LE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an Int32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt32BE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an Int32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt32BE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an Int32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an Int32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeInt32LE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an Int32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an Int32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertInt32LE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Reads an UInt8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt8 value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt8(offset?: number): number; | ||
/** | ||
* Reads an UInt16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt16BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt16BE(offset?: number): number; | ||
/** | ||
* Reads an UInt16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt16LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt16LE(offset?: number): number; | ||
/** | ||
* Reads an UInt32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt32BE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt32BE(offset?: number): number; | ||
/** | ||
* Reads an UInt32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an UInt32LE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readUInt32LE(offset?: number): number; | ||
/** | ||
* Writes an UInt8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt8 value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt8(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an UInt8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt8 value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt8(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an UInt16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt16BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt16BE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an UInt16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt16BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt16BE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an UInt16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt16LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt16LE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an UInt16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt16LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt16LE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an UInt32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt32BE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt32BE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an UInt32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt32BE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt32BE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes an UInt32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes an UInt32LE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeUInt32LE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts an UInt32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts an UInt32LE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertUInt32LE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Reads an FloatBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an FloatBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readFloatBE(offset?: number): number; | ||
/** | ||
* Reads an FloatLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an FloatLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readFloatLE(offset?: number): number; | ||
/** | ||
* Writes a FloatBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a FloatBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeFloatBE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts a FloatBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a FloatBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertFloatBE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes a FloatLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a FloatLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeFloatLE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts a FloatLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a FloatLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertFloatLE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Reads an DoublEBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an DoublEBE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readDoubleBE(offset?: number): number; | ||
/** | ||
* Reads an DoubleLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
* Reads an DoubleLE value from the current read position or an optionally provided offset. | ||
* | ||
* @param offset { Number } The offset to read data from (optional) | ||
* @return { Number } | ||
*/ | ||
readDoubleLE(offset?: number): number; | ||
/** | ||
* Writes a DoubleBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a DoubleBE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeDoubleBE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts a DoubleBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a DoubleBE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertDoubleBE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Writes a DoubleLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Writes a DoubleLE value to the current write position (or at optional offset). | ||
* | ||
* @param value { Number } The value to write. | ||
* @param offset { Number } The offset to write the value at. | ||
* | ||
* @return this | ||
*/ | ||
writeDoubleLE(value: number, offset?: number): SmartBuffer; | ||
/** | ||
* Inserts a DoubleLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
* Inserts a DoubleLE value at the given offset value. | ||
* | ||
* @param value { Number } The value to insert. | ||
* @param offset { Number } The offset to insert the value at. | ||
* | ||
* @return this | ||
*/ | ||
insertDoubleLE(value: number, offset: number): SmartBuffer; | ||
/** | ||
* Reads a String from the current read position. | ||
* | ||
* @param arg1 { Number | String } The number of bytes to read as a String, or the BufferEncoding to use for | ||
* the string (Defaults to instance level encoding). | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
readString( | ||
arg1?: number | BufferEncoding, | ||
encoding?: BufferEncoding | ||
): string; | ||
* Reads a String from the current read position. | ||
* | ||
* @param arg1 { Number | String } The number of bytes to read as a String, or the BufferEncoding to use for | ||
* the string (Defaults to instance level encoding). | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
readString(arg1?: number | BufferEncoding, encoding?: BufferEncoding): string; | ||
/** | ||
* Inserts a String | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param offset { Number } The offset to insert the string at. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
insertString( | ||
value: string, | ||
offset: number, | ||
encoding?: BufferEncoding | ||
): SmartBuffer; | ||
* Inserts a String | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param offset { Number } The offset to insert the string at. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
insertString(value: string, offset: number, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Writes a String | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
writeString( | ||
value: string, | ||
arg2?: number | BufferEncoding, | ||
encoding?: BufferEncoding | ||
): SmartBuffer; | ||
* Writes a String | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
writeString(value: string, arg2?: number | BufferEncoding, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Reads a null-terminated String from the current read position. | ||
* | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
* Reads a null-terminated String from the current read position. | ||
* | ||
* @param encoding { String } The BufferEncoding to use for the string (Defaults to instance level encoding). | ||
* | ||
* @return { String } | ||
*/ | ||
readStringNT(encoding?: BufferEncoding): string; | ||
/** | ||
* Inserts a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
insertStringNT( | ||
value: string, | ||
offset: number, | ||
encoding?: BufferEncoding | ||
): void; | ||
* Inserts a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
insertStringNT(value: string, offset: number, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Writes a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
writeStringNT( | ||
value: string, | ||
arg2?: number | BufferEncoding, | ||
encoding?: BufferEncoding | ||
): void; | ||
* Writes a null-terminated String. | ||
* | ||
* @param value { String } The String value to write. | ||
* @param arg2 { Number | String } The offset to write the string to, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
* | ||
* @return this | ||
*/ | ||
writeStringNT(value: string, arg2?: number | BufferEncoding, encoding?: BufferEncoding): SmartBuffer; | ||
/** | ||
* Reads a Buffer from the internal read position. | ||
* | ||
* @param length { Number } The length of data to read as a Buffer. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
* Reads a Buffer from the internal read position. | ||
* | ||
* @param length { Number } The length of data to read as a Buffer. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
readBuffer(length?: number): Buffer; | ||
/** | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
insertBuffer(value: Buffer, offset: number): SmartBuffer; | ||
/** | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a Buffer to the current write position. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
writeBuffer(value: Buffer, offset?: number): SmartBuffer; | ||
/** | ||
* Reads a null-terminated Buffer from the current read poisiton. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
* Reads a null-terminated Buffer from the current read poisiton. | ||
* | ||
* @return { Buffer } | ||
*/ | ||
readBufferNT(): Buffer; | ||
/** | ||
* Inserts a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Inserts a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
insertBufferNT(value: Buffer, offset: number): SmartBuffer; | ||
/** | ||
* Writes a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Writes a null-terminated Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
* | ||
* @return this | ||
*/ | ||
writeBufferNT(value: Buffer, offset?: number): SmartBuffer; | ||
/** | ||
* Clears the SmartBuffer instance to its original empty state. | ||
*/ | ||
* Clears the SmartBuffer instance to its original empty state. | ||
*/ | ||
clear(): SmartBuffer; | ||
/** | ||
* Gets the remaining data left to be read from the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the remaining data left to be read from the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
remaining(): number; | ||
/** | ||
* Gets the current read offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the current read offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
/** | ||
* Sets the read offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
* Sets the read offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
readOffset: number; | ||
/** | ||
* Gets the current write offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
* Gets the current write offset value of the SmartBuffer instance. | ||
* | ||
* @return { Number } | ||
*/ | ||
/** | ||
* Sets the write offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
* Sets the write offset value of the SmartBuffer instance. | ||
* | ||
* @param offset { Number } - The offset value to set. | ||
*/ | ||
writeOffset: number; | ||
/** | ||
* Gets the currently set string encoding of the SmartBuffer instance. | ||
* | ||
* @return { BufferEncoding } The string Buffer encoding currently set. | ||
*/ | ||
* Gets the currently set string encoding of the SmartBuffer instance. | ||
* | ||
* @return { BufferEncoding } The string Buffer encoding currently set. | ||
*/ | ||
/** | ||
* Sets the string encoding of the SmartBuffer instance. | ||
* | ||
* @param encoding { BufferEncoding } The string Buffer encoding to set. | ||
*/ | ||
* Sets the string encoding of the SmartBuffer instance. | ||
* | ||
* @param encoding { BufferEncoding } The string Buffer encoding to set. | ||
*/ | ||
encoding: BufferEncoding; | ||
/** | ||
* Gets the underlying internal Buffer. (This includes unmanaged data in the Buffer) | ||
* | ||
* @return { Buffer } The Buffer value. | ||
*/ | ||
* Gets the underlying internal Buffer. (This includes unmanaged data in the Buffer) | ||
* | ||
* @return { Buffer } The Buffer value. | ||
*/ | ||
readonly internalBuffer: Buffer; | ||
/** | ||
* Gets the value of the internal managed Buffer (Includes managed data only) | ||
* | ||
* @param { Buffer } | ||
*/ | ||
* Gets the value of the internal managed Buffer (Includes managed data only) | ||
* | ||
* @param { Buffer } | ||
*/ | ||
toBuffer(): Buffer; | ||
/** | ||
* Gets the String value of the internal managed Buffer | ||
* | ||
* @param encoding { String } The BufferEncoding to display the Buffer as (defaults to instance level encoding). | ||
*/ | ||
* Gets the String value of the internal managed Buffer | ||
* | ||
* @param encoding { String } The BufferEncoding to display the Buffer as (defaults to instance level encoding). | ||
*/ | ||
toString(encoding?: BufferEncoding): string; | ||
/** | ||
* Destroys the SmartBuffer instance. | ||
*/ | ||
* Destroys the SmartBuffer instance. | ||
*/ | ||
destroy(): SmartBuffer; | ||
/** | ||
* Handles inserting and writing strings. | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param isInsert { Boolean } True if inserting a string, false if writing. | ||
* @param arg2 { Number | String } The offset to insert the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
* Handles inserting and writing strings. | ||
* | ||
* @param value { String } The String value to insert. | ||
* @param isInsert { Boolean } True if inserting a string, false if writing. | ||
* @param arg2 { Number | String } The offset to insert the string at, or the BufferEncoding to use. | ||
* @param encoding { String } The BufferEncoding to use for writing strings (defaults to instance encoding). | ||
*/ | ||
private _handleString(value, isInsert, arg3?, encoding?); | ||
/** | ||
* Handles writing or insert of a Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
* Handles writing or insert of a Buffer. | ||
* | ||
* @param value { Buffer } The Buffer to write. | ||
* @param offset { Number } The offset to write the Buffer to. | ||
*/ | ||
private _handleBuffer(value, isInsert, offset?); | ||
/** | ||
* Ensures that the internal Buffer is large enough to read data. | ||
* | ||
* @param length { Number } The length of the data that needs to be read. | ||
* @param offset { Number } The offset of the data that needs to be read. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to read data. | ||
* | ||
* @param length { Number } The length of the data that needs to be read. | ||
* @param offset { Number } The offset of the data that needs to be read. | ||
*/ | ||
private ensureReadable(length, offset?); | ||
/** | ||
* Ensures that the internal Buffer is large enough to insert data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to insert data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written. | ||
*/ | ||
private ensureInsertable(dataLength, offset); | ||
/** | ||
* Ensures that the internal Buffer is large enough to write data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written (defaults to writeOffset). | ||
*/ | ||
* Ensures that the internal Buffer is large enough to write data. | ||
* | ||
* @param dataLength { Number } The length of the data that needs to be written. | ||
* @param offset { Number } The offset of the data to be written (defaults to writeOffset). | ||
*/ | ||
private _ensureWriteable(dataLength, offset?); | ||
/** | ||
* Ensures that the internal Buffer is large enough to write at least the given amount of data. | ||
* | ||
* @param minLength { Number } The minimum length of the data needs to be written. | ||
*/ | ||
* Ensures that the internal Buffer is large enough to write at least the given amount of data. | ||
* | ||
* @param minLength { Number } The minimum length of the data needs to be written. | ||
*/ | ||
private _ensureCapacity(minLength); | ||
/** | ||
* Reads a numeric number value using the provided function. | ||
* | ||
* @param func { Function(offset: number) => number } The function to read data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes read. | ||
* @param offset { Number } The offset to read from (optional). When this is not provided, the managed readOffset is used instead. | ||
* | ||
* @param { Number } | ||
*/ | ||
* Reads a numeric number value using the provided function. | ||
* | ||
* @param func { Function(offset: number) => number } The function to read data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes read. | ||
* @param offset { Number } The offset to read from (optional). When this is not provided, the managed readOffset is used instead. | ||
* | ||
* @param { Number } | ||
*/ | ||
private _readNumberValue(func, byteSize, offset?); | ||
/** | ||
* Inserts a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
* Inserts a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
private _insertNumberValue(func, byteSize, value, offset); | ||
/** | ||
* Writes a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
* Writes a numeric number value based on the given offset and value. | ||
* | ||
* @param func { Function(offset: number, offset?) => number} The function to write data on the internal Buffer with. | ||
* @param byteSize { Number } The number of bytes written. | ||
* @param value { Number } The number value to write. | ||
* @param offset { Number } the offset to write the number at (REQUIRED). | ||
* | ||
*/ | ||
private _writeNumberValue(func, byteSize, value, offset?); | ||
} | ||
export { SmartBufferOptions, SmartBuffer }; | ||
} | ||
export { SmartBufferOptions, SmartBuffer }; |
Sorry, the diff of this file is not supported yet
15
189387
1880