@chickenjdk/byteutils
    Preparing search index...

    Class readableStream

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    destroyed drained read readArrayBackwardsEndian readArrayEndian readBackwards readBackwardsEndian readEndian readUint8ArrayBackwardsEndian readUint8ArrayEndian

    Accessors

    _chunks isLe stream

    Methods

    onceDrain onDrain readArray readArrayBackwards readDouble readFloat readReadableBuffer readSignedInteger readSignedIntegerBigint readSignedIntegerByte readSignedIntegerByteArray readSignedOnesComplement readSignedOnesComplementBigint readSignedOnesComplementByte readSignedOnesComplementByteArray readString readTwosComplement readTwosComplementBigint readTwosComplementByte readTwosComplementByteArray readUint8Array readUint8ArrayBackwards readUnsignedInt readUnsignedIntBigint shift

    Constructors

    Properties

    destroyed: boolean = false
    drained: boolean = true
    read:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a array OR Uint8Array from the start of the buffer

    How many bytes to read

    readArrayBackwardsEndian:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a number array (0-255) from the start of the buffer backwards (endian-dependent)

    How many bytes to read

    readArrayEndian:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a number array (0-255) from the start of the buffer (endian-dependent)

    How many bytes to read

    readBackwards:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a array OR Uint8Array from the start of the buffer backwards

    How many bytes to read

    readBackwardsEndian:
        | cloneFunc<
            | ((...args: [bytes: number]) => Promise)
            | ((...args: [bytes: number]) => Promise),
        >
        | cloneFunc<
            | ((...args: [bytes: number]) => Promise)
            | ((...args: [bytes: number]) => Promise),
        > = ...

    Read a array-like (May be a array or uint8array but don't count on it) from the start of the buffer backwards (endian-dependent)

    readEndian:
        | cloneFunc<
            | ((...args: [bytes: number]) => Promise)
            | ((...args: [bytes: number]) => Promise),
        >
        | cloneFunc<
            | ((...args: [bytes: number]) => Promise)
            | ((...args: [bytes: number]) => Promise),
        > = ...

    Read a array-like (May be a array or uint8array but don't count on it) from the start of the buffer (endian-dependent)

    The data to write

    readUint8ArrayBackwardsEndian:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a Uint8Array from the start of the buffer backwards (endian-dependent)

    readUint8ArrayEndian:
        | ((...args: [bytes: number]) => Promise)
        | ((...args: [bytes: number]) => Promise) = ...

    Read a Uint8Array from the start of the buffer (endian-dependent)

    Accessors

    _chunks

    • get isLe(): boolean

      If the buffer is little endian

      Returns boolean

    • set isLe(isLe: boolean): void

      If the buffer is little endian

      Parameters

      • isLe: boolean

      Returns void

    Methods

    • Read a number array (0-255) from the start of the buffer

      Parameters

      • bytes: number

        How many bytes to read

      Returns Promise<number[]>

    • Read a number array (0-255) from the start of the buffer backwards

      Parameters

      • bytes: number

        How many bytes to read

      Returns Promise<number[]>

    • Parse a double

      Returns Promise<number>

      The parsed float

    • Parse a float

      Returns Promise<number>

      The parsed float

    • Read a ReadableBuffer from the start of the buffer

      Parameters

      • bytes: number

        How many bytes to read

      Returns Promise<readableBuffer>

    • Parse a signed integer

      Parameters

      • bytes: number

        How many bytes long the signed integer is

      Returns Promise<number>

      The parsed signed integer

    • Parse a signed integer as a bigint

      Parameters

      • bytes: number

        How many bytes long the signed integer is

      Returns Promise<bigint>

      The parsed signed integer (as a bigint)

    • Parse a signed integer from a byte

      Returns Promise<number>

      The parsed signed integer

    • Parse a signed integer from a byte

      Parameters

      • bytes: number

      Returns Promise<number[]>

      The parsed signed integers

    • Parse a signed one's complement

      Parameters

      • bytes: number

        How long the signed one's complement is

      Returns Promise<number>

      The parsed signed ones compement

    • Parse a signed one's complement as a bigint

      Parameters

      • bytes: number

        How long the signed one's complement is

      Returns Promise<bigint>

      The parsed signed ones compement (as a bigint)

    • Parse a signed one's complement from a byte

      Returns Promise<number>

      The parsed signed one's compement

    • Parse signed one's complements (one byte each) from bytes

      Parameters

      • bytes: number

        How many one's complements to read

      Returns Promise<number[]>

      The parsed signed one's compements

    • Parse a string

      Parameters

      • bytes: number

        How many bytes long the string is

      • Optionalmutf8: boolean = false

        If the string is mutf8

      Returns Promise<string>

      The parsed string

    • Parse a two's complement

      Parameters

      • bytes: number

        How many bytes it is

      Returns Promise<number>

      The parsed twos complement

    • Parse a two's complement as a bigint

      Parameters

      • bytes: number

        How many bytes it is

      Returns Promise<bigint>

      The parsed twos complement (as a bigint)

    • Parse a two's complement from a single byte

      Returns Promise<number>

      The parsed twos complement

    • Parse a two's complements from single bytes

      Parameters

      • bytes: number

        How many two's complements to parse

      Returns Promise<number[]>

      The parsed twos complements

    • Read a Uint8Array from the start of the buffer

      Parameters

      • bytes: number

        How many bytes to read

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Read a Uint8Array from the start of the buffer backwards

      Parameters

      • bytes: number

        How many bytes to read

      Returns Promise<Uint8Array<ArrayBufferLike>>

    • Read a unsigned integer

      Parameters

      • bytes: number

        How many bytes the data is

      Returns Promise<number>

      The parsed unsigned integer

    • Read a unsigned integer as a bigint

      Parameters

      • bytes: number

        How many bytes the data is

      Returns Promise<bigint>

      The parsed unsigned integer (as a bigint)

    • Read from the start of the buffer

      Returns Promise<number>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods