bireader 1.0.14 → 1.0.17

package/lib/cjs/types/src/reader.d.ts

@@ -1,33 +1,35 @@
 /// <reference types="node" />
 /**
+* Binary reader, includes bitfields and strings
 *
-* byte reader, includes bitfields and strings
-*
-* @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```
-* @param {number} byteOffset - byte offset to start reader, default is 0
-* @param {number} bitOffset - bit offset to start reader, 0-7
-* @param {string} endianness - endianness ```big``` or ```little``` (default ```little```)
+* @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```. Always found in ``biwriter.data``
+* @param {number} byteOffset - Byte offset to start reader (default 0)
+* @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
+* @param {string} endianness - Endianness ```big``` or ```little``` (default ```little```)
+* @param {boolean} strict - Strict mode: if true does not extend supplied array on outside write (default true)
 */
 export declare class bireader {
     endian: string;
     offset: number;
     bitoffset: number;
     size: number;
+    strict: boolean;
     errorDump: boolean;
-    data: Array<Buffer | Uint8Array>;
-    private check_size;
+    data: any;
     private isBuffer;
     private isBufferOrUint8Array;
+    extendArray(to_padd: number): void;
+    private check_size;
     /**
+    * Binary reader, includes bitfields and strings
     *
-    * byte reader, includes bitfields and strings
-    *
-    * @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```
-    * @param {number} byteOffset - byte offset to start reader, default is 0
-    * @param {number} bitOffset - bit offset to start reader, 0-7
-    * @param {string} endianness - endianness ```big``` or ```little``` (default ```little```)
+    * @param {Buffer|Uint8Array} data - ```Buffer``` or ```Uint8Array```. Always found in ``biwriter.data``
+    * @param {number} byteOffset - Byte offset to start reader (default 0)
+    * @param {number} bitOffset - Bit offset 0-7 to start reader (default 0)
+    * @param {string} endianness - Endianness ```big``` or ```little``` (default ```little```)
+    * @param {boolean} strict - Strict mode: if true does not extend supplied array on outside write (default true)
     */
-    constructor(data: Array<Buffer | Uint8Array>, byteOffset?: number, bitOffset?: number, endianness?: string);
+    constructor(data: Array<Buffer | Uint8Array>, byteOffset?: number, bitOffset?: number, endianness?: string, strict?: boolean);
     /**
     *
     * Change endian, defaults to little
@@ -62,203 +64,430 @@ export declare class bireader {
     */
     le(): void;
     /**
-    * Move current read byte or bit position
+    * Offset current byte or bit position
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} bytes - bytes to skip
-    * @param {number} bits - bits to skip
+    * @param {number} bytes - Bytes to skip
+    * @param {number} bits - Bits to skip (0-7)
     */
     skip(bytes: number, bits?: number): void;
     /**
-    * Move current read byte or bit position
+    * Offset current byte or bit position
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} bytes - bytes to skip
-    * @param {number} bits - bits to skip
+    * @param {number} bytes - Bytes to skip
+    * @param {number} bits - Bits to skip (0-7)
     */
-    fskip(bytes: number, bits?: number): void;
+    jump(bytes: number, bits?: number): void;
     /**
-    * Change current byte or bit read position
+    * Change position directly to address
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @param {number} byte - byte to set to
+    * @param {number} bit - bit to set to (0-7)
     */
     goto(byte: number, bit?: number): void;
     /**
-    * Change current byte or bit read position
+    * Change position directly to address
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @param {number} byte - byte to set to
+    * @param {number} bit - bit to set to (0-7)
     */
     seek(byte: number, bit?: number): void;
     /**
-    * Change current byte or bit read position
+    * Change position directly to address
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @param {number} byte - byte to set to
+    * @param {number} bit - bit to set to (0-7)
     */
-    fseek(byte: number, bit?: number): void;
+    pointer(byte: number, bit?: number): void;
     /**
-    * Change current byte or bit read position
+    * Change position directly to address
+    * Note: Will extend array if strict mode is off and outside of max size
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @param {number} byte - byte to set to
+    * @param {number} bit - bit to set to (0-7)
+    */
+    warp(byte: number, bit?: number): void;
+    /**
+    * Set byte and bit position to start of data
     */
-    jump(byte: number, bit?: number): void;
+    rewind(): void;
     /**
-    * Change current byte or bit read position
+    * Set byte and bit position to start of data
+    */
+    gotostart(): void;
+    /**
+    * Get the current byte position
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @return {number} current byte position
     */
-    pointer(byte: number, bit?: number): void;
+    tell(): number;
     /**
-    * Change current byte or bit read position
+    * Get the current byte position
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @return {number} current byte position
     */
-    warp(byte: number, bit?: number): void;
+    getOffset(): number;
     /**
-    * Change current byte or bit read position
+    * Get the current byte position
     *
-    * @param {number} byte - byte to jump to
-    * @param {number} bit - bit to jump to (0-7)
+    * @return {number} current byte position
     */
-    fsetpos(byte: number, bit?: number): void;
+    saveOffset(): number;
     /**
-    * Set offset to start of file
+    * Get the current bit position (0-7)
+    *
+    * @return {number} current bit position
     */
-    rewind(): void;
+    tellB(): number;
     /**
-    * Set offset to start of file
+    * Get the current bit position (0-7)
+    *
+    * @return {number} current bit position
     */
-    gotostart(): void;
+    getOffsetBit(): number;
     /**
-    * Set offset to start of file
+    * Get the current bit position (0-7)
+    *
+    * @return {number} current bit position
     */
-    tostart(): void;
+    saveOffsetAbsBit(): number;
     /**
-    * Get the current byte position
+    * Get the current absolute bit position (from start of data)
     *
-    * @return {number} current byte position
+    * @return {number} current absolute bit position
     */
-    ftell(): number;
+    tellAbsB(): number;
     /**
-    * Get the current byte position
+    * Get the current absolute bit position (from start of data)
     *
-    * @return {number} current byte position
+    * @return {number} current absolute bit position
     */
-    tell(): number;
+    getOffsetAbsBit(): number;
     /**
-    * Get the current byte position
+    * Get the current absolute bit position (from start of data)
     *
-    * @return {number} current byte position
+    * @return {number} current absolute bit position
     */
-    fgetpos(): number;
+    saveOffsetBit(): number;
     /**
-    * Get the current byte position
+    * Disallows extending data if position is outside of max size
+    */
+    restrict(): void;
+    /**
+    * Allows extending data if position is outside of max size
+    */
+    unrestrict(): void;
+    /**
+    * XOR data
     *
-    * @return {number} current byte position
+    * @param {number|string|Uint8Array|Buffer} xorKey - Value, string or array to XOR
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
     */
-    saveOffset(): number;
+    xor(xorKey: number | string | Uint8Array | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
     /**
-    * Truncates array from start to current position unless supplied
-    * Note: Does not affect supplied data
-    * @param {number} startOffset - Start location, default 0
-    * @param {number} endOffset - end location, default current write position
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    * XOR data
+    *
+    * @param {number|string|Uint8Array|Buffer} xorKey - Value, string or array to XOR
+    * @param {number} length - Length in bytes to XOR from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
     */
-    clip(startOffset?: number, endOffset?: number): Array<Buffer | Uint8Array>;
+    xorThis(xorKey: number | string | Uint8Array | Buffer, length?: number, consume?: boolean): void;
     /**
-    * Truncates array from start to current position unless supplied
-    * Note: Does not affect supplied data
-    * @param {number} startOffset - Start location, default 0
-    * @param {number} endOffset - end location, default current write position
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    * OR data
+    *
+    * @param {number|string|Uint8Array|Buffer} orKey - Value, string or array to OR
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
     */
-    crop(startOffset?: number, endOffset?: number): Array<Buffer | Uint8Array>;
+    or(orKey: number | string | Uint8Array | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
     /**
-    * Truncates array from start to current position unless supplied
-    * Note: Does not affect supplied data
-    * @param {number} startOffset - Start location, default 0
-    * @param {number} endOffset - end location, default current write position
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    * OR data
+    *
+    * @param {number|string|Uint8Array|Buffer} orKey - Value, string or array to OR
+    * @param {number} length - Length in bytes to OR from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
     */
-    truncate(startOffset?: number, endOffset?: number): Array<Buffer | Uint8Array>;
+    orThis(orKey: number | string | Uint8Array | Buffer, length?: number, consume?: boolean): void;
     /**
-    * Truncates array from start to current position unless supplied
-    * Note: Does not affect supplied data
-    * @param {number} startOffset - Start location, default 0
-    * @param {number} endOffset - end location, default current write position
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    * AND data
+    *
+    * @param {number|string|Uint8Array|Buffer} andKey - Value, string or array to AND
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    and(andKey: number | string | Uint8Array | Buffer, startOffset?: number, endOffset?: number, consume?: boolean): void;
+    /**
+    * AND data
+    *
+    * @param {number|string|Uint8Array|Buffer} andKey - Value, string or array to AND
+    * @param {number} length - Length in bytes to AND from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    andThis(andKey: number | string | Uint8Array | Buffer, length?: number, consume?: boolean): void;
+    /**
+    * Not data
+    *
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    not(startOffset?: number, endOffset?: number, consume?: boolean): void;
+    /**
+    * Not data
+    *
+    * @param {number} length - Length in bytes to NOT from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    notThis(length?: number, consume?: boolean): void;
+    /**
+    * Left shift data
+    *
+    * @param {number} shiftValue - Value to left shift
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    lShift(shiftValue: number, startOffset?: number, endOffset?: number, consume?: boolean): void;
+    /**
+    * Left shift data
+    *
+    * @param {number} shiftValue - Value to left shift
+    * @param {number} length - Length in bytes to left shift from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    lShiftThis(shiftValue: number, length?: number, consume?: boolean): void;
+    /**
+    * Right shift data
+    *
+    * @param {number} shiftValue - Value to right shift
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    rShift(shiftValue: number, startOffset?: number, endOffset?: number, consume?: boolean): void;
+    /**
+    * Right shift data
+    *
+    * @param {number} shiftValue - Value to right shift
+    * @param {number} length - Length in bytes to right shift from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    rShiftThis(shiftValue: number, length?: number, consume?: boolean): void;
+    /**
+    * Add value to data
+    *
+    * @param {number} addValue - Value to add
+    * @param {number} startOffset - Start location (default current byte position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    add(addValue: number, startOffset?: number, endOffset?: number, consume?: boolean): void;
+    /**
+    * Add value to data
+    *
+    * @param {number} addValue - Value to add
+    * @param {number} length - Length in bytes to add from curent position (default 1 byte for value, length of string or array for Uint8Array or Buffer)
+    * @param {boolean} consume - Move current position to end of data (default false)
+    */
+    addThis(addValue: number, length?: number, consume?: boolean): void;
+    /**
+    * Deletes part of data from start to current byte position unless supplied, returns removed
+    * Note: Errors in strict mode
+    *
+    * @param {number} startOffset - Start location (default 0)
+    * @param {number} endOffset - End location (default current position)
+    * @param {boolean} consume - Move position to end of removed data (default false)
+    * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+    */
+    delete(startOffset?: number, endOffset?: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    /**
+    * Deletes part of data from start to current byte position unless supplied, returns removed
+    * Note: Errors in strict mode
+    *
+    * @param {number} startOffset - Start location (default 0)
+    * @param {number} endOffset - End location (default current position)
+    * @param {boolean} consume - Move position to end of removed data (default false)
+    * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+    */
+    clip(startOffset?: number, endOffset?: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    /**
+    * Deletes part of data from current byte position to supplied length, returns removed
+    * Note: Errors in strict mode
+    *
+    * @param {number} length - Length of data in bytes to remove
+    * @param {boolean} consume - Move position to end of removed data (default false)
+    * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+    */
+    crop(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    /**
+    * Deletes part of data from current position to supplied length, returns removed
+    * Note: Only works in strict mode
+    *
+    * @param {number} length - Length of data in bytes to remove
+    * @param {boolean} consume - Move position to end of removed data (default false)
+    * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+    */
+    drop(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    /**
+    * Returns part of data from current byte position to end of data unless supplied
+    *
+    * @param {number} startOffset - Start location (default current position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move position to end of lifted data (default false)
+    * @param {number} fillValue - Byte value to to fill returned data (does NOT fill unless supplied)
+    * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
     */
-    slice(startOffset?: number, endOffset?: number): Array<Buffer | Uint8Array>;
+    lift(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Array<Buffer | Uint8Array>;
     /**
-    * Extract array from current position to length supplied
+    * Returns part of data from current byte position to end of data unless supplied
+    *
+    * @param {number} startOffset - Start location (default current position)
+    * @param {number} endOffset - End location (default end of data)
+    * @param {boolean} consume - Move position to end of lifted data (default false)
+    * @param {number} fillValue - Byte value to to fill returned data (does NOT fill unless supplied)
+    * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
+    */
+    fill(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Array<Buffer | Uint8Array>;
+    /**
+    * Extract data from current position to length supplied
     * Note: Does not affect supplied data
-    * @param {number} length - length of data to copy from current offset
-    * @param {number} consume - moves offset to end of length
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    *
+    * @param {number} length - Length of data in bytes to copy from current offset
+    * @param {number} consume - Moves offset to end of length
+    * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
     */
     extract(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
     /**
-    * Extract array from current position to length supplied
+    * Extract data from current position to length supplied
     * Note: Does not affect supplied data
-    * @param {number} length - length of data to copy from current offset
-    * @param {number} consume - moves offset to end of length
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    *
+    * @param {number} length - Length of data in bytes to copy from current offset
+    * @param {number} consume - Moves offset to end of length
+    * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
     */
-    wrap(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    slice(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
     /**
-    * Extract array from current position to length supplied
+    * Extract data from current position to length supplied
     * Note: Does not affect supplied data
-    * @param {number} length - length of data to copy from current offset
-    * @param {number} consume - moves offset to end of length
-    * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+    *
+    * @param {number} length - Length of data in bytes to copy from current offset
+    * @param {number} consume - Moves offset to end of length
+    * @returns {Buffer|Uint8Array} Selected data as ```Uint8Array``` or ```Buffer```
     */
-    lift(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    wrap(length: number, consume?: boolean): Array<Buffer | Uint8Array>;
+    /**
+    * Inserts data into data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current byte position to end of data (default false)
+    * @param {number} offset - Byte position to add at (defaults to current position)
+    */
+    insert(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
+    /**
+    * Inserts data into data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current byte position to end of data (default false)
+    * @param {number} offset - Byte position to add at (defaults to current position)
+    */
+    place(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
+    /**
+    * Replaces data in data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to replace in data
+    * @param {boolean} consume - Move current byte position to end of data (default false)
+    * @param {number} offset - Offset to add it at (defaults to current position)
+    */
+    replace(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
+    /**
+    * Replaces data in data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to replace in data
+    * @param {boolean} consume - Move current byte position to end of data (default false)
+    * @param {number} offset - Offset to add it at (defaults to current position)
+    */
+    overwrite(data: Buffer | Uint8Array, consume?: boolean, offset?: number): void;
+    /**
+    * Adds data to start of supplied data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current write position to end of data (default false)
+    */
+    unshift(data: Buffer | Uint8Array, consume?: boolean): void;
+    /**
+    * Adds data to start of supplied data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current write position to end of data (default false)
+    */
+    prepend(data: Buffer | Uint8Array, consume?: boolean): void;
+    /**
+    * Adds data to end of supplied data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current write position to end of data (default false)
+    */
+    push(data: Buffer | Uint8Array, consume?: boolean): void;
+    /**
+    * Adds data to end of supplied data
+    * Note: Must be same data type as supplied data. Errors on strict mode.
+    *
+    * @param {Buffer|Uint8Array} data - ```Uint8Array``` or ```Buffer``` to add to data
+    * @param {boolean} consume - Move current write position to end of data (default false)
+    */
+    append(data: Buffer | Uint8Array, consume?: boolean): void;
     /**
     * Returns current data
+    *
     * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
     */
     get(): Array<Buffer | Uint8Array>;
     /**
     * Returns current data
+    *
     * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
     */
     return(): Array<Buffer | Uint8Array>;
     /**
-    * removes reading data
+    * removes data
     */
     end(): void;
     /**
-    * removes reading data
+    * removes data
     */
     close(): void;
     /**
-    * removes reading data
+    * removes data
     */
     done(): void;
     /**
-    * removes reading data
+    * removes data
     */
     finished(): void;
     /**
-    * Turn hexdump on error off, default on
-    */
-    errorDumpOff(): void;
-    /**
-    * Turn hexdump on error on, default on
-    */
-    errorDumpOn(): void;
-    /**
     * Console logs data as hex dump
     *
-    * @param {object} options - options object
+    * @param {object} options
     * ```javascript
     *   {
     *       length: 192, // number of bytes to log, default 192 or end of data
-    *       startByte: 0, // byte to start dump, default current position
-    *       supressUnicode: false // Supress unicode character preview for cleaner columns
+    *       startByte: 0, // byte to start dump (default current byte position)
+    *       supressUnicode: false // Supress unicode character preview for even columns
     *   }
     * ```
     */
@@ -268,6 +497,26 @@ export declare class bireader {
         supressUnicode?: boolean;
     }): void;
     /**
+    * Turn hexdump on error off (default on)
+    */
+    errorDumpOff(): void;
+    /**
+    * Turn hexdump on error on (default on)
+    */
+    errorDumpOn(): void;
+    /**
+    *
+    * Write bits, must have at least value and number of bits
+    *
+    * ``Note``: When returning to a byte write, remaining bits are skipped
+    *
+    * @param {number} value - value as int
+    * @param {number} bits - number of bits to write
+    * @param {boolean} unsigned - if value is unsigned
+    * @param {string} endian - ``big`` or ``little``
+    */
+    writeBit(value: number, bits: number, unsigned?: boolean, endian?: string): void;
+    /**
     * Bit field reader
     *
     * Note: When returning to a byte read, remaining bits are dropped
@@ -295,9 +544,10 @@ export declare class bireader {
     * Note: When returning to a byte read, remaining bits are dropped
     *
     * @param {boolean} unsigned - if the value is unsigned
+    * @param {string} endian - ``big`` or ``little`
     * @returns number
     */
-    bit1(unsigned?: boolean): number;
+    bit1(unsigned?: boolean, endian?: string): number;
     /**
     * Bit field reader
     *
@@ -2005,6 +2255,13 @@ export declare class bireader {
     */
     readByte(unsigned?: boolean): number;
     /**
+    * Write byte
+    *
+    * @param {number} value - value as int
+    * @param {boolean} unsigned - if the value is unsigned
+    */
+    writeByte(value: number, unsigned?: boolean): void;
+    /**
     * Read byte
     *
     * @param {boolean} unsigned - if value is unsigned or not
@@ -2045,6 +2302,14 @@ export declare class bireader {
     */
     readInt16(unsigned?: boolean, endian?: string): number;
     /**
+    * Write int16
+    *
+    * @param {number} value - value as int
+    * @param {boolean} unsigned - if the value is unsigned
+    * @param {string} endian - ``big`` or ``little`
+    */
+    writeInt16(value: number, unsigned?: boolean, endian?: string): void;
+    /**
     * Read short
     *
     * @param {boolean} unsigned - if value is unsigned or not
@@ -2204,6 +2469,13 @@ export declare class bireader {
     */
     readHalfFloat(endian?: string): number;
     /**
+    * Writes half float
+    *
+    * @param {number} value - value as int
+    * @param {string} endian - ``big`` or ``little`
+    */
+    writeHalfFloat(value: number, endian?: string): void;
+    /**
     * Read half float
     *
     * @param {string} endian - ```big``` or ```little```
@@ -2262,6 +2534,14 @@ export declare class bireader {
     */
     readInt32(unsigned?: boolean, endian?: string): number;
     /**
+    * Write int32
+    *
+    * @param {number} value - value as int
+    * @param {boolean} unsigned - if the value is unsigned
+    * @param {string} endian - ``big`` or ``little`
+    */
+    writeInt32(value: number, unsigned?: boolean, endian?: string): void;
+    /**
     * Read 32 bit integer
     *
     * @param {boolean} unsigned - if value is unsigned or not
@@ -2451,6 +2731,13 @@ export declare class bireader {
     */
     readFloat(endian?: string): number;
     /**
+   * Write float
+   *
+   * @param {number} value - value as int
+   * @param {string} endian - ``big`` or ``little`
+   */
+    writeFloat(value: number, endian?: string): void;
+    /**
     * Read float
     *
     * @param {string} endian - ```big``` or ```little```
@@ -2489,6 +2776,14 @@ export declare class bireader {
     */
     readInt64(unsigned?: boolean, endian?: string): bigint;
     /**
+    * Write 64 bit integer
+    *
+    * @param {number} value - value as int
+    * @param {boolean} unsigned - if the value is unsigned
+    * @param {string} endian - ``big`` or ``little`
+    */
+    writeInt64(value: number, unsigned?: boolean, endian?: string): void;
+    /**
     * Read signed 64 bit integer
     * @param {boolean} unsigned - if value is unsigned or not
     * @param {string} endian - ```big``` or ```little```
@@ -2637,6 +2932,14 @@ export declare class bireader {
     */
     readDoubleFloat(endian?: string): number;
     /**
+    * Writes double float
+    *
+    * @param {number} value - value as int
+    * @param {number} offset - byte offset (default last write position)
+    * @param {string} endian - ``big`` or ``little`
+    */
+    writeDoubleFloat(value: number, endian?: string): void;
+    /**
     * Read double float
     *
     * @param {string} endian - ```big``` or ```little```
@@ -2712,6 +3015,49 @@ export declare class bireader {
         encoding?: string;
         endian?: string;
     }): string;
+    /**
+    * Writes string, use options object for different types
+    *
+    *
+    * @param {string} string - text string
+    * @param {object} options - options:
+    * ```javascript
+    * {
+    *  length: string.length,  //for fixed length, non-terminate value utf strings
+    *  stringType: "utf-8", //utf-8, utf-16, pascal or wide-pascal
+    *  terminateValue: 0x00, // only with stringType: "utf"
+    *  lengthWriteSize: 1, //for pascal strings. 1, 2 or 4 byte length write size
+    *  encoding: "utf-8", //TextEncoder accepted types
+    *  endian: "little", //for wide-pascal and utf-16
+    * }
+    * ```
+    */
+    writeString(string: string, options?: {
+        length?: number;
+        stringType?: string;
+        terminateValue?: number;
+        lengthWriteSize?: number;
+        stripNull?: boolean;
+        encoding?: string;
+        endian?: string;
+    }): void;
+    /**
+    * Reads string, use options object for different types
+    *
+    * @param {object} options
+    * ```javascript
+    * {
+    *  length: number, //for fixed length, non-terminate value utf strings
+    *  stringType: "utf-8", //utf-8, utf-16, pascal or wide-pascal
+    *  terminateValue: 0x00, // only for non-fixed length utf strings
+    *  lengthReadSize: 1, //for pascal strings. 1, 2 or 4 byte length read size
+    *  stripNull: true, // removes 0x00 characters
+    *  encoding: "utf-8", //TextEncoder accepted types
+    *  endian: "little", //for wide-pascal and utf-16
+    * }
+    * ```
+    * @return string
+    */
     string(options?: {
         length?: number;
         stringType?: string;