kaven-basic - v6.0.0
    Preparing search index...

    Class BitString

    Represents a string of bits and provides various bitwise operations and utilities.

    The BitString class allows for the creation, manipulation, and conversion of bit strings. It supports initialization from numbers, strings (binary or hexadecimal), and provides methods for bitwise operations (AND, OR, XOR, NOT), shifting, rotating, reflecting, and conversion to numbers or byte arrays.

    const bits = new BitString(10); // "1010"
    bits.SetBit(1, true); // Set the least significant bit
    const sum = bits.Add(new BitString(5));
    • Bit offsets are counted from right to left, starting at 1.
    • Supports both binary and hexadecimal string initialization.
    • Provides static helpers for 2D array initialization and byte conversion.

    1.0.0

    1.0.5

    Index

    Constructors

    constructor

    Accessors

    HEX Length

    Methods

    Add AND AnyBit Clone Equals GetBit LeftRotate LeftShift NOT OR Reflect RightRotate RightShift SetBit SetLength Swap ToBytes ToNumber toString XOR FromBytes Initialize2d

    Constructors

    • Returns BitString

    • Parameters

      • initialValue: number

      Returns BitString

    • Parameters

      • initialValue: number
      • type: "bin" | "hex"

      Returns BitString

    • Parameters

      • initialValue: string

      Returns BitString

    • Parameters

      • initialValue: string
      • radix: number

      Returns BitString

    • Parameters

      • initialValue: string
      • type: "bin" | "hex"

      Returns BitString

    Accessors

    • get HEX(): string

      Gets the hexadecimal string representation of the bit string.

      Returns string

      The hexadecimal representation of the current bit string.

    • get Length(): number

      Gets the length of the binary string.

      Returns number

      The number of characters in the binary string.

    Methods

    • Adds the current BitString to another BitString and returns the result as a new BitString. The addition is performed bit by bit, starting from the least significant bit (rightmost), and handles carry-over similar to binary addition.

      Parameters

      • val: BitString

        The BitString to add to the current BitString.

      Returns BitString

      A new BitString representing the sum of the two BitStrings.

      1.1.20

      2019-04-01

    • Performs a bitwise AND operation between this BitString and another BitString or number.

      If the input is a number, it is first converted to a BitString. The lengths of both BitStrings are adjusted to match the longer one by padding with zeros if necessary. The result is a new BitString where each bit is the logical AND of the corresponding bits in the two operands.

      Parameters

      • val: number | BitString

        The BitString or number to perform the AND operation with.

      Returns BitString

      A new BitString representing the result of the bitwise AND operation.

      1.1.20

      2019-04-01

    • Checks if any bit in the binary string is set to '1'.

      Returns boolean

      true if at least one bit is '1'; otherwise, false.

    • Creates and returns a new BitString instance that is a copy of the current object.

      Returns BitString

      A new BitString object with the same binary string as the original.

    • Determines whether this BitString is equal to another BitString, ignoring leading zeros in their binary string representations.

      Parameters

      • another: BitString

        The BitString instance to compare with.

      Returns boolean

      true if the normalized binary strings are equal; otherwise, false.

    • Retrieves the value of the bit at the specified offset from the end of the bit string.

      Parameters

      • offset: number

        The 1-based position from the end of the bit string to retrieve the bit from. Must be greater than or equal to 1.

      • defaultVal: boolean = false

        The value to return if the offset is out of bounds. Defaults to false.

      Returns boolean

      true if the bit at the specified offset is '1', false if it is '0', or defaultVal if the offset is out of bounds.

      If the provided offset is less than 1.

      1.1.20

      2019-04-01

    • Performs a left rotation (circular shift) of the bit string by the specified number of positions.

      Parameters

      • n: number

        The number of positions to rotate the bit string to the left.

      • bits: number = 64

        The total number of bits to consider for the rotation. Defaults to 64.

      Returns BitString

      A new BitString instance with the bits rotated to the left by n positions.

      1.0.0

      2025-06-27

    • Shifts the current bit string to the left by the specified number of positions. This operation appends n zeros to the right end of the bit string.

      Parameters

      • n: number

        The number of positions to shift left (number of zeros to append).

      Returns BitString

      A new BitString instance with the bits shifted left by n positions.

    • Returns a new BitString instance with each bit inverted.

      Iterates through the current binary string and flips each bit:

      • '0' becomes '1'
      • '1' becomes '0'

      Returns BitString

      A new BitString with all bits inverted.

      1.1.20

      2019-04-01

    • Performs a bitwise OR operation between this BitString and another BitString or number.

      If a number is provided, it is first converted to a BitString. The operation is performed bit by bit, starting from the least significant bit. The resulting BitString will have a length equal to the longer of the two operands.

      Parameters

      • val: number | BitString

        The BitString or number to OR with this BitString.

      Returns BitString

      A new BitString representing the result of the bitwise OR operation.

      1.1.20

      2019-04-01

    • Returns a new BitString instance with the bits in reverse order. Optionally sets the length of the bit string before reflecting.

      Parameters

      • Optionalbits: number

        Optional. If provided, sets the length of the bit string before reflecting.

      Returns BitString

      A new BitString with the bits reversed.

    • Rotates the bits of the current BitString instance to the right by the specified number of positions.

      Parameters

      • n: number

        The number of positions to rotate the bits to the right.

      • bits: number = 64

        The total number of bits to consider for the rotation. Defaults to 64.

      Returns BitString

      The BitString instance after performing the right rotation.

      1.0.0

      2025-06-27

    • Performs a right shift operation on the current BitString by the specified number of bits. Pads the left side with zeros and truncates bits from the right.

      Parameters

      • n: number

        The number of bits to shift to the right.

      Returns BitString

      A new BitString instance representing the shifted value.

    • Sets the bit at the specified offset to the given boolean value.

      The offset is 1-based, where 1 refers to the least significant bit (rightmost). If the offset exceeds the current length, the bit string is left-padded with zeros as needed.

      Parameters

      • offset: number

        The 1-based position of the bit to set. Must be greater than or equal to 1.

      • val: boolean

        The boolean value to set the bit to (true for '1', false for '0').

      Returns this

      The updated BitString instance.

      If the offset is less than 1.

    • Sets the length of the bit string to the specified number of bits.

      If the current length is greater than the specified length, the bit string is truncated from the left. If the current length is less than the specified length, the bit string is left-padded with zeros.

      Parameters

      • bits: number

        The desired length of the bit string in bits.

      Returns this

      The current instance for method chaining.

    • Reverses the order of bytes in the current bit string.

      Parameters

      • bytes: number = 8

        The number of bytes to consider for swapping. Defaults to 8.

      Returns BitString

      A new BitString instance with the byte order reversed.

      This method sets the bit string length to bytes * 8, splits the string into 8-bit chunks (bytes), reverses their order, and joins them back together. The result is returned as a new BitString.

    • Converts the bit string to an array of bytes.

      Parameters

      • Optionalbits: number

        Optional. If provided, sets the length of the bit string to the specified number of bits before conversion.

      Returns number[]

      An array of numbers, where each number represents a byte from the bit string.

    • Converts the internal binary string representation (binStr) to a number.

      Returns number

      The numeric value of the binary string.

    • Converts the bit string to its string representation in the specified format.

      Parameters

      • type: "bin" | "hex" = "hex"

        The output format for the bit string. Can be BitStringType.BIN for binary or BitStringType.HEX for hexadecimal. Defaults to BitStringType.HEX.

      • trim: boolean = false

        If true, leading zeros are trimmed from the hexadecimal output. Defaults to false.

      Returns string

      The string representation of the bit string in the specified format. Returns "0" if the bit string is empty or consists only of zeros.

      If an invalid BitStringType is provided.

    • Performs a bitwise XOR operation between this BitString and another BitString or number.

      If the input value is a number, it is first converted to a BitString. The lengths of both BitStrings are adjusted to match by padding with leading zeros if necessary. Returns a new BitString representing the result of the XOR operation.

      Parameters

      • val: number | BitString

        The BitString or number to XOR with this BitString.

      Returns BitString

      A new BitString containing the result of the XOR operation.

      1.1.20

      2019-04-01

    • Creates a new BitString instance from one or more byte values.

      Each byte is converted to its 8-bit binary representation and concatenated to form the complete bit string.

      Parameters

      • ...bytes: number[]

        One or more numbers representing bytes (0-255) to convert.

      Returns BitString

      A new BitString instance representing the concatenated bits of the input bytes.

    • Initializes a 2D array of BitString instances with the specified dimensions.

      Parameters

      • x: number

        The number of rows in the 2D array.

      • y: number

        The number of columns in each row of the 2D array.

      Returns BitString[][]

      A 2D array (BitString[][]) where each element is a new instance of BitString.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods