bireader 3.0.1 → 3.1.1

package/{build/cjs/common.d.ts → dist/core/BiBaseStream.d.ts}

@@ -1,173 +1,140 @@
 /// <reference types="node" />
-type BiReader = import('./bireader.ts').BiReader;
-type BiWriter = import('./biwriter.ts').BiWriter;
-export type BiOptions = {
+import { endian, hexdumpOptions, stringOptions } from '../common.js';
+/**
+ * For file system in Node
+ */
+type FileDescriptor = number;
+/**
+ * file system read modes
+ */
+type fsMode = "w+" | "r";
+export declare class BiBaseStreamer {
     /**
-     * Byte offset to start writer, default is 0
+     * Endianness of default read.
+     *
+     * @type {endian}
      */
-    byteOffset?: number;
+    endian: endian;
     /**
-     *  Byte offset to start writer, default is 0
+     * Current read byte location.
      */
-    bitOffset?: number;
+    offset: number;
     /**
-     * Endianness ``big`` or ``little`` (default little)
+     * Current read byte's bit location.
      */
-    endianness?: "little" | "big";
+    bitoffset: number;
     /**
-     * Strict mode: if ``true`` does not extend supplied array on outside write (default ``false``)
+     * Size in bytes of the current file.
      */
-    strict?: boolean;
+    size: number;
     /**
-     * Amount of data to add when extending the buffer array when strict mode is false. Note: Changes login in ``.get`` and ``.return``.
+     * Size in bits of the current file.
      */
-    extendBufferSize?: number;
-};
-export declare function isBuffer(obj: Buffer | Uint8Array): boolean;
-export declare function check_size(_this: BiReader | BiWriter | ReaderBase, write_bytes: number, write_bit?: number, offset?: number): number;
-export declare function buffcheck(obj: Buffer | Uint8Array | ReaderBase): boolean;
-export declare function arraybuffcheck(_this: BiReader | BiWriter | ReaderBase, obj: Buffer | Uint8Array): boolean;
-export declare function extendarray(_this: BiReader | BiWriter | ReaderBase, to_padd: number): void;
-export declare function checkSize(_this: BiReader | BiWriter | ReaderBase, write_bytes: number, write_bit?: number, offset?: number): number;
-export declare function skip(_this: BiReader | BiWriter | ReaderBase, bytes: number, bits?: number): void;
-export declare function align(_this: BiReader | BiWriter | ReaderBase, n: number): void;
-export declare function alignRev(_this: BiReader | BiWriter | ReaderBase, n: number): void;
-export declare function goto(_this: BiReader | BiWriter | ReaderBase, bytes: number, bits?: number): void;
-export declare function remove(_this: BiReader | BiWriter | ReaderBase, startOffset?: number, endOffset?: number, consume?: boolean, remove?: boolean, fillValue?: number): any;
-export declare function addData(_this: BiReader | BiWriter | ReaderBase, data: Buffer | Uint8Array, consume?: boolean, offset?: number, replace?: boolean): void;
-type hexdumpOptions = {
+    sizeB: number;
     /**
-     * number of bytes to log, default ``192`` or end of data
+     * Allows the file to extend reading or writing outside of current size
      */
-    length?: number;
+    strict: boolean;
     /**
-     * byte to start dump (default ``0``)
+     * Console log a hexdump on error.
      */
-    startByte?: number;
+    errorDump: boolean;
     /**
-     * Supress unicode character preview for even columns.
+     * Current buffer chunk.
+     *
+     * @type {Buffer}
      */
-    supressUnicode?: boolean;
+    data: Buffer | null;
     /**
-     * Returns the hex dump string instead of logging it.
+     * When the data buffer needs to be extended while strict mode is ``false``, this will be the amount it extends.
+     *
+     * Otherwise it extends just the amount of the next written value.
+     *
+     * This can greatly speed up data writes when large files are being written.
+     *
+     * NOTE: Using ``BiWriter.get`` or ``BiWriter.return`` will now remove all data after the current write position. Use ``BiWriter.data`` to get the full buffer instead.
      */
-    returnString?: boolean;
-};
-/**
- * Creates hex dump string. Will console log or return string if set in options.
- *
- * @param {Uint8Array|Buffer} src - Uint8Array or Buffer
- * @param {hexdumpOptions?} options - hex dump options
- * @param {number?} options.length - number of bytes to log, default ``192`` or end of data
- * @param {number?} options.startByte - byte to start dump (default ``0``)
- * @param {boolean?} options.supressUnicode - Supress unicode character preview for even columns.
- * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
- */
-export declare function hexdump(src: Uint8Array | Buffer, options?: hexdumpOptions): void | string;
-export declare function hexDump(_this: BiReader | BiWriter | ReaderBase, options?: hexdumpOptions): void | string;
-export declare function AND(_this: BiReader | BiWriter | ReaderBase, and_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function OR(_this: BiReader | BiWriter | ReaderBase, or_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function XOR(_this: BiReader | BiWriter | ReaderBase, xor_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function NOT(_this: BiReader | BiWriter | ReaderBase, start?: number, end?: number, consume?: boolean): any;
-export declare function LSHIFT(_this: BiReader | BiWriter | ReaderBase, shift_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function RSHIFT(_this: BiReader | BiWriter | ReaderBase, shift_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function ADD(_this: BiReader | BiWriter | ReaderBase, add_key: any, start?: number, end?: number, consume?: boolean): any;
-export declare function fString(_this: BiReader | BiWriter | ReaderBase, searchString: string): number;
-export declare function fNumber(_this: BiReader | BiWriter | ReaderBase, targetNumber: number, bits: number, unsigned: boolean, endian?: string): number;
-export declare function fHalfFloat(_this: BiReader | BiWriter | ReaderBase, targetNumber: number, endian?: string): number;
-export declare function fFloat(_this: BiReader | BiWriter | ReaderBase, targetNumber: number, endian?: string): number;
-export declare function fBigInt(_this: BiReader | BiWriter | ReaderBase, targetNumber: number, unsigned: boolean, endian?: string): number;
-export declare function fDoubleFloat(_this: BiReader | BiWriter | ReaderBase, targetNumber: number, endian?: string): number;
-export declare function wbit(_this: BiReader | BiWriter | ReaderBase, value: number, bits: number, unsigned?: boolean, endian?: string): void;
-export declare function rbit(_this: BiReader | BiWriter | ReaderBase, bits?: number, unsigned?: boolean, endian?: string): number;
-export declare function wbyte(_this: BiReader | BiWriter | ReaderBase, value: number, unsigned?: boolean): void;
-export declare function rbyte(_this: BiReader | BiWriter | ReaderBase, unsigned?: boolean): number;
-export declare function wint16(_this: BiReader | BiWriter | ReaderBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function rint16(_this: BiReader | BiWriter | ReaderBase, unsigned?: boolean, endian?: string): number;
-export declare function rhalffloat(_this: BiReader | BiWriter | ReaderBase, endian?: string): number;
-export declare function whalffloat(_this: BiReader | BiWriter | ReaderBase, value: number, endian?: string): void;
-export declare function wint32(_this: BiReader | BiWriter | ReaderBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function rint32(_this: BiReader | BiWriter | ReaderBase, unsigned?: boolean, endian?: string): number;
-export declare function rfloat(_this: BiReader | BiWriter | ReaderBase, endian?: string): number;
-export declare function wfloat(_this: BiReader | BiWriter | ReaderBase, value: number, endian?: string): void;
-export declare function rint64(_this: BiReader | BiWriter | ReaderBase, unsigned?: boolean, endian?: string): bigint;
-export declare function wint64(_this: BiReader | BiWriter | ReaderBase, value: number, unsigned?: boolean, endian?: string): void;
-export declare function wdfloat(_this: BiReader | BiWriter | ReaderBase, value: number, endian?: string): void;
-export declare function rdfloat(_this: BiReader | BiWriter | ReaderBase, endian?: string): number;
-export declare function rstring(_this: BiReader | BiWriter | ReaderBase, options?: {
-    length?: number;
-    stringType?: string;
-    terminateValue?: number;
-    lengthReadSize?: number;
-    stripNull?: boolean;
-    encoding?: string;
-    endian?: string;
-}): string;
-export declare function wstring(_this: BiReader | BiWriter | ReaderBase, string: string, options?: {
-    length?: number;
-    stringType?: string;
-    terminateValue?: number;
-    lengthWriteSize?: number;
-    stripNull?: boolean;
-    encoding?: string;
-    endian?: string;
-}): void;
-export declare class ReaderBase {
+    extendBufferSize: number;
+    fd: FileDescriptor | null;
+    filePath: string;
+    fsMode: fsMode;
     /**
-     * Endianness of default read.
-     * @type {'little'|'big'}
+     * The settings that used when using the .str getter / setter
      */
-    endian: string;
+    private strDefaults;
+    maxFileSize: number | null;
+    constructor(filePath: string, readwrite: boolean);
     /**
-     * Current read byte location.
+     * Settings for when using .str
+     *
+     * @param {stringOptions} settings options to use with .str
      */
-    offset: number;
+    set strSettings(settings: stringOptions);
     /**
-     * Current read byte's bit location.
+     * Enabling write mode in reader.
+     *
+     * @param {boolean} writeMode - Enabling write mode in reader.
      */
-    bitoffset: number;
+    writeMode(writeMode: boolean): void;
     /**
-     * Size in bytes of the current buffer.
+     * Opens the file. Must be run before reading or writing.
+     *
+     * @returns {number} file size
      */
-    size: number;
+    open(): number;
     /**
-     * Size in bits of the current buffer.
+     * Internal update size
      */
-    sizeB: number;
+    updateSize(): void;
     /**
-     * Allows the buffer to extend reading or writing outside of current size
+     * Closes the file.
+     *
+     * @returns {void}
      */
-    strict: boolean;
+    close(): void;
     /**
-     * Console log a hexdump on error.
+     * Internal reader
+     *
+     * @param start - likely this.offset
+     * @param length
+     * @param consume
+     * @returns
      */
-    errorDump: boolean;
+    read(start: number, length: number, consume?: boolean): Buffer;
     /**
-     * Current buffer data.
-     * @type {Buffer|Uint8Array}
+     * Internal writer
+     *
+     * @param start - likely this.offset
+     * @param data
+     * @param consume
+     * @returns {number}
      */
-    data: any;
+    write(start: number, data: Buffer, consume?: boolean): number;
     /**
-     * When the data buffer needs to be extended while strict mode is ``false``, this will be the amount it extends.
+     * internal write commit
      *
-     * Otherwise it extends just the amount of the next written value.
+     * @param consume
+     * @returns {number}
+     */
+    commit(consume?: boolean): number;
+    /**
+     * internal extend
      *
-     * This can greatly speed up data writes when large files are being written.
      *
-     * NOTE: Using ``BiWriter.get`` or ``BiWriter.return`` will now remove all data after the current write position. Use ``BiWriter.data`` to get the full buffer instead.
+     * @param length amount needed
+     * @returns {void}
      */
-    extendBufferSize: number;
+    extendArray(length: number): void;
     isBufferOrUint8Array(obj: Buffer | Uint8Array): boolean;
-    extendArray(to_padd: number): void;
     /**
      *
      * Change endian, defaults to little.
      *
      * Can be changed at any time, doesn't loose position.
      *
-     * @param {string} endian - endianness ``big`` or ``little``
+     * @param {endian} endian - endianness ``big`` or ``little``
      */
-    endianness(endian: string): void;
+    endianness(endian: endian): void;
     /**
      * Sets endian to big.
      */
@@ -355,9 +322,9 @@ export declare class ReaderBase {
      *
      * Use ``.data`` instead if you want the full buffer data.
      *
-     * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+     * @returns {Buffer|Uint8Array} ``Buffer``
      */
-    get get(): Buffer | Uint8Array;
+    get get(): Buffer;
     /**
      * Returns current data.
      *
@@ -365,19 +332,19 @@ export declare class ReaderBase {
      *
      * Use ``.data`` instead if you want the full buffer data.
      *
-     * @returns {Buffer|Uint8Array} ``Buffer`` or ``Uint8Array``
+     * @returns {Buffer} ``Buffer``
      */
-    get return(): Buffer | Uint8Array;
+    get return(): Buffer;
     /**
-    * Creates hex dump string. Will console log or return string if set in options.
-    *
-    * @param {object} options
-    * @param {hexdumpOptions?} options - hex dump options
-    * @param {number?} options.length - number of bytes to log, default ``192`` or end of data
-    * @param {number?} options.startByte - byte to start dump (default ``0``)
-    * @param {boolean?} options.supressUnicode - Supress unicode character preview for even columns.
-    * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
-    */
+ * Creates hex dump string. Will console log or return string if set in options.
+ *
+ * @param {object} options
+ * @param {hexdumpOptions?} options - hex dump options
+ * @param {number?} options.length - number of bytes to log, default ``192`` or end of data
+ * @param {number?} options.startByte - byte to start dump (default ``0``)
+ * @param {boolean?} options.supressUnicode - Supress unicode character preview for even columns.
+ * @param {boolean?} options.returnString - Returns the hex dump string instead of logging it.
+ */
     hexdump(options?: hexdumpOptions): void | string;
     /**
      * Turn hexdump on error off (default on).
@@ -399,10 +366,6 @@ export declare class ReaderBase {
      * removes data.
      */
     end(): void;
-    /**
-     * removes data.
-     */
-    close(): void;
     /**
      * removes data.
      */
@@ -430,9 +393,9 @@ export declare class ReaderBase {
      *
      * @param {number} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findByte(value: number, unsigned?: boolean, endian?: string): number;
+    findByte(value: number, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for short value (can be signed or unsigned) position from current read position.
      *
@@ -442,9 +405,9 @@ export declare class ReaderBase {
      *
      * @param {number} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findShort(value: number, unsigned?: boolean, endian?: string): number;
+    findShort(value: number, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for integer value (can be signed or unsigned) position from current read position.
      *
@@ -454,9 +417,9 @@ export declare class ReaderBase {
      *
      * @param {number} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findInt(value: number, unsigned?: boolean, endian?: string): number;
+    findInt(value: number, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for 64 bit value (can be signed or unsigned) position from current read position.
      *
@@ -466,9 +429,9 @@ export declare class ReaderBase {
      *
      * @param {number} value - Number to search for.
      * @param {boolean} unsigned - If the number is unsigned (default true)
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findInt64(value: number, unsigned?: boolean, endian?: string): number;
+    findInt64(value: number, unsigned?: boolean, endian?: endian): number;
     /**
      * Searches for half float value position from current read position.
      *
@@ -477,9 +440,9 @@ export declare class ReaderBase {
      * Does not change current read position.
      *
      * @param {number} value - Number to search for.
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findHalfFloat(value: number, endian?: string): number;
+    findHalfFloat(value: number, endian?: endian): number;
     /**
      * Searches for float value position from current read position.
      *
@@ -488,9 +451,9 @@ export declare class ReaderBase {
      * Does not change current read position.
      *
      * @param {number} value - Number to search for.
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findFloat(value: number, endian?: string): number;
+    findFloat(value: number, endian?: endian): number;
     /**
      * Searches for double float value position from current read position.
      *
@@ -499,9 +462,9 @@ export declare class ReaderBase {
      * Does not change current read position.
      *
      * @param {number} value - Number to search for.
-     * @param {string} endian - endianness of value (default set endian).
+     * @param {endian} endian - endianness of value (default set endian).
      */
-    findDoubleFloat(value: number, endian?: string): number;
+    findDoubleFloat(value: number, endian?: endian): number;
     /**
      * Aligns current byte position.
      *
@@ -609,25 +572,25 @@ export declare class ReaderBase {
      * @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``
+     * @returns {Buffer} Removed data as ``Buffer``
      */
-    delete(startOffset?: number, endOffset?: number, consume?: boolean): Buffer | Uint8Array;
+    delete(startOffset?: number, endOffset?: number, consume?: boolean): Buffer;
     /**
      * Deletes part of data from current byte position to end, returns removed.
      *
      * Note: Errors in strict mode.
      *
-     * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+     * @returns {Buffer} Removed data as ``Buffer``
      */
-    clip(): Buffer | Uint8Array;
+    clip(): Buffer;
     /**
      * Deletes part of data from current byte position to end, returns removed.
      *
      * Note: Errors in strict mode.
      *
-     * @returns {Buffer|Uint8Array} Removed data as ``Buffer`` or ``Uint8Array``
+     * @returns {Buffer} Removed data as ``Buffer``
      */
-    trim(): Buffer | Uint8Array;
+    trim(): Buffer;
     /**
      * Deletes part of data from current byte position to supplied length, returns removed.
      *
@@ -635,9 +598,9 @@ export declare class ReaderBase {
      *
      * @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``
+     * @returns {Buffer} Removed data as ``Buffer``
      */
-    crop(length: number, consume?: boolean): Buffer | Uint8Array;
+    crop(length: number, consume?: boolean): Buffer;
     /**
      * Deletes part of data from current position to supplied length, returns removed.
      *
@@ -645,13 +608,13 @@ export declare class ReaderBase {
      *
      * @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``
+     * @returns {Buffer} Removed data as ``Buffer``
      */
-    drop(length: number, consume?: boolean): Buffer | Uint8Array;
+    drop(length: number, consume?: boolean): Buffer;
     /**
      * Replaces data in data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -661,7 +624,7 @@ export declare class ReaderBase {
     /**
      * Replaces data in data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -675,9 +638,9 @@ export declare class ReaderBase {
      * @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``
+     * @returns {Buffer} Selected data as ``Buffer``
      */
-    lift(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Buffer | Uint8Array;
+    lift(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Buffer;
     /**
      * Returns part of data from current byte position to end of data unless supplied.
      *
@@ -685,9 +648,9 @@ export declare class ReaderBase {
      * @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``
+     * @returns {Buffer} Selected data as ``Buffer``
      */
-    fill(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Buffer | Uint8Array;
+    fill(startOffset?: number, endOffset?: number, consume?: boolean, fillValue?: number): Buffer;
     /**
      * Extract data from current position to length supplied.
      *
@@ -695,9 +658,9 @@ export declare class ReaderBase {
      *
      * @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``
+     * @returns {Buffer} Selected data as ``Buffer``
      */
-    extract(length: number, consume?: boolean): Buffer | Uint8Array;
+    extract(length: number, consume?: boolean): Buffer;
     /**
      * Extract data from current position to length supplied.
      *
@@ -705,9 +668,9 @@ export declare class ReaderBase {
      *
      * @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``
+     * @returns {Buffer} Selected data as ``Buffer``
      */
-    slice(length: number, consume?: boolean): Buffer | Uint8Array;
+    slice(length: number, consume?: boolean): Buffer;
     /**
      * Extract data from current position to length supplied.
      *
@@ -715,13 +678,13 @@ export declare class ReaderBase {
      *
      * @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``
+     * @returns {Buffer|Uint8Array} Selected data or ``Buffer``
      */
-    wrap(length: number, consume?: boolean): Buffer | Uint8Array;
+    wrap(length: number, consume?: boolean): Buffer;
     /**
      * Inserts data into data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -731,7 +694,7 @@ export declare class ReaderBase {
     /**
      * Inserts data into data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -741,7 +704,7 @@ export declare class ReaderBase {
     /**
      * Adds data to start of supplied data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -750,7 +713,7 @@ export declare class ReaderBase {
     /**
      * Adds data to start of supplied data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -759,7 +722,7 @@ export declare class ReaderBase {
     /**
      * Adds data to end of supplied data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -768,7 +731,7 @@ export declare class ReaderBase {
     /**
      * Adds data to end of supplied data.
      *
-     * Note: Must be same data type as supplied data. Errors on strict mode.
+     * Note: 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)
@@ -900,9 +863,9 @@ export declare class ReaderBase {
      * @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``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeBit(value: number, bits: number, unsigned?: boolean, endian?: string): void;
+    writeBit(value: number, bits: number, unsigned?: boolean, endian?: endian): void;
     /**
      * Bit field writer.
      *
@@ -952,10 +915,10 @@ export declare class ReaderBase {
      *
      * @param {number} bits - bits to read
      * @param {boolean} unsigned - if the value is unsigned
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readBit(bits?: number, unsigned?: boolean, endian?: string): number;
+    readBit(bits?: number, unsigned?: boolean, endian?: endian): number;
     /**
      * Bit field reader.
      *
@@ -1039,25 +1002,25 @@ export declare class ReaderBase {
      * Read short.
      *
      * @param {boolean} unsigned - if value is unsigned or not
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readInt16(unsigned?: boolean, endian?: string): number;
+    readInt16(unsigned?: boolean, endian?: endian): number;
     /**
      * Write int16.
      *
      * @param {number} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeInt16(value: number, unsigned?: boolean, endian?: string): void;
+    writeInt16(value: number, unsigned?: boolean, endian?: endian): void;
     /**
      * Write unsigned int16.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeUInt16(value: number, endian?: string): void;
+    writeUInt16(value: number, endian?: endian): void;
     /**
      * Write unsigned int16.
      *
@@ -1079,11 +1042,11 @@ export declare class ReaderBase {
     /**
      * Read unsigned short.
      *
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      *
      * @returns {number}
      */
-    readUInt16(endian?: string): number;
+    readUInt16(endian?: endian): number;
     /**
      * Read unsigned short in little endian.
      *
@@ -1111,17 +1074,17 @@ export declare class ReaderBase {
     /**
      * Read half float.
      *
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readHalfFloat(endian?: string): number;
+    readHalfFloat(endian?: endian): number;
     /**
      * Writes half float.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeHalfFloat(value: number, endian?: string): void;
+    writeHalfFloat(value: number, endian?: endian): void;
     /**
      * Writes half float.
      *
@@ -1150,25 +1113,25 @@ export declare class ReaderBase {
      * Read 32 bit integer.
      *
      * @param {boolean} unsigned - if value is unsigned or not
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readInt32(unsigned?: boolean, endian?: string): number;
+    readInt32(unsigned?: boolean, endian?: endian): number;
     /**
      * Write int32.
      *
      * @param {number} value - value as int
      * @param {boolean} unsigned - if the value is unsigned
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeInt32(value: number, unsigned?: boolean, endian?: string): void;
+    writeInt32(value: number, unsigned?: boolean, endian?: endian): void;
     /**
      * Write unsigned int32.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeUInt32(value: number, endian?: string): void;
+    writeUInt32(value: number, endian?: endian): void;
     /**
      * Write signed int32.
      *
@@ -1220,17 +1183,17 @@ export declare class ReaderBase {
     /**
      * Read float.
      *
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readFloat(endian?: string): number;
+    readFloat(endian?: endian): number;
     /**
      * Write float.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeFloat(value: number, endian?: string): void;
+    writeFloat(value: number, endian?: endian): void;
     /**
      * Write float.
      *
@@ -1259,25 +1222,25 @@ export declare class ReaderBase {
      * Read signed 64 bit integer.
      *
      * @param {boolean} unsigned - if value is unsigned or not
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian?} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readInt64(unsigned?: boolean, endian?: string): bigint;
+    readInt64(unsigned?: boolean, endian?: endian): 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``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeInt64(value: number, unsigned?: boolean, endian?: string): void;
+    writeInt64(value: number, unsigned?: boolean, endian?: endian): void;
     /**
      * Write unsigned 64 bit integer.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeUInt64(value: number, endian?: string): void;
+    writeUInt64(value: number, endian?: endian): void;
     /**
      * Write signed 64 bit integer.
      *
@@ -1335,17 +1298,17 @@ export declare class ReaderBase {
     /**
      * Read double float.
      *
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      * @returns {number}
      */
-    readDoubleFloat(endian?: string): number;
+    readDoubleFloat(endian?: endian): number;
     /**
      * Writes double float.
      *
      * @param {number} value - value as int
-     * @param {string} endian - ``big`` or ``little``
+     * @param {endian} endian - ``big`` or ``little``
      */
-    writeDoubleFloat(value: number, endian?: string): void;
+    writeDoubleFloat(value: number, endian?: endian): void;
     /**
      * Writes double float.
      *
@@ -1373,55 +1336,28 @@ export declare class ReaderBase {
     /**
     * 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
+    * @param {stringOptions} options
+    * @param {stringOptions["length"]?} options.length - for fixed length, non-terminate value utf strings
+    * @param {stringOptions["stringType"]?} options.stringType - utf-8, utf-16, pascal or wide-pascal
+    * @param {stringOptions["terminateValue"]?} options.terminateValue - only with stringType: "utf"
+    * @param {stringOptions["lengthReadSize"]?} options.lengthReadSize - for pascal strings. 1, 2 or 4 byte length read size
+    * @param {stringOptions["encoding"]?} options.encoding - TextEncoder accepted types
+    * @param {stringOptions["endian"]?} options.endian - for wide-pascal and utf-16
+    * @return {Promise<string>}
     */
-    readString(options?: {
-        length?: number;
-        stringType?: string;
-        terminateValue?: number;
-        lengthReadSize?: number;
-        stripNull?: boolean;
-        encoding?: string;
-        endian?: string;
-    }): string;
+    readString(options?: stringOptions): 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
-    * }
-    * ```
+    * @param {stringOptions?} options
+    * @param {stringOptions["length"]?} options.length - for fixed length, non-terminate value utf strings
+    * @param {stringOptions["stringType"]?} options.stringType - utf-8, utf-16, pascal or wide-pascal
+    * @param {stringOptions["terminateValue"]?} options.terminateValue - only with stringType: "utf"
+    * @param {stringOptions["lengthWriteSize"]?} options.lengthWriteSize - for pascal strings. 1, 2 or 4 byte length write size
+    * @param {stringOptions["encoding"]?} options.encoding - TextEncoder accepted types
+    * @param {stringOptions["endian"]?} options.endian - 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;
+    writeString(string: string, options?: stringOptions): void;
 }
 export {};
-//# sourceMappingURL=common.d.ts.map