ZenFS
    Preparing search index...

    Class SuperBlock

    The super block structure for a single-buffer file system

    Hierarchy

    • BigUint64Array<ArrayBufferLike>
      • SuperBlock

    Indexable

    • [index: number]: bigint
    Index

    Constructors

    • Parameters

      • ...args: [buffer: ArrayBufferLike, byteOffset?: number, length?: number]

      Returns SuperBlock

    Properties

    "[toStringTag]": "BigUint64Array"
    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    byteLength: number

    The length in bytes of the array.

    byteOffset: number

    The offset in bytes of the array.

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    constructor: typeof SuperBlock

    The initial value of Object.prototype.constructor is the standard built-in Object constructor.

    length: number

    The length of the array.

    metadata: MetadataBlock
    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    Accessors

    _padding: any

    Padded to 256 bytes

    checksum: any

    The crc32c checksum for the super block.

    flags: any

    Flags for the file system. Currently unused

    inode_format: any

    Which format of Inode is used

    label: any

    An optional label for the file system

    magic: any

    Signature for the superblock.

    metadata_block_size: any

    The size in bytes of a metadata block. Not currently configurable.

    metadata_offset: any

    Offset of the current metadata block

    metadata_offset_: any

    Reserved for 64-bit offset expansion

    total_bytes: any

    The total size of the entire file system, including the super block and metadata

    used_bytes: any

    The number of used bytes, including the super block and metadata

    uuid: any

    A UUID for this file system

    version: any

    The version of the on-disk format

    Methods

    • Returns ArrayIterator<bigint>

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns undefined | bigint

    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    • Yields index, value pairs for every entry in the array.

      Returns ArrayIterator<[number, bigint]>

    • Determines whether all the members of an array satisfy the specified test.

      Parameters

      • predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => boolean

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns false, or until the end of the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: bigint

        value to fill array section with

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    • Returns the elements of an array that meet the condition specified in a callback function.

      Parameters

      • predicate: (value: bigint, index: number, array: BigUint64Array<ArrayBufferLike>) => any

        A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

      Returns BigUint64Array<ArrayBuffer>

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      Parameters

      • predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => boolean

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

      • OptionalthisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns undefined | bigint

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => boolean

        find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      • OptionalthisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    • Returns the value of the last element in the array where predicate is true, and undefined otherwise.

      Type Parameters

      • S extends bigint

      Parameters

      • predicate: (value: bigint, index: number, array: this) => value is S

        findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast returns undefined.

      • OptionalthisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns undefined | S

    • Parameters

      • predicate: (value: bigint, index: number, array: this) => unknown
      • OptionalthisArg: any

      Returns undefined | bigint

    • Returns the index of the last element in the array where predicate is true, and -1 otherwise.

      Parameters

      • predicate: (value: bigint, index: number, array: this) => unknown

        findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex returns -1.

      • OptionalthisArg: any

        If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

      Returns number

    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: (value: bigint, index: number, array: BigUint64Array<ArrayBufferLike>) => void

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns void

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: bigint

        The element to search for.

      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: bigint

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    • Internal

      Checks to see if length bytes are unused, starting at offset. Not for external use!

      Parameters

      • offset: number
      • length: number

      Returns boolean

    • Adds all the elements of an array separated by the specified separator string.

      Parameters

      • Optionalseparator: string

        A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

      Returns string

    • Yields each index in the array.

      Returns ArrayIterator<number>

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: bigint

        The value to locate in the array.

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      Parameters

      • callbackfn: (value: bigint, index: number, array: BigUint64Array<ArrayBufferLike>) => bigint

        A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

      Returns BigUint64Array<ArrayBuffer>

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      • callbackfn: (
            previousValue: bigint,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => bigint

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      Returns bigint

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type Parameters

      • U

      Parameters

      • callbackfn: (
            previousValue: U,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => U

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      • callbackfn: (
            previousValue: bigint,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => bigint

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

      Returns bigint

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type Parameters

      • U

      Parameters

      • callbackfn: (
            previousValue: U,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => U

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

      Returns U

    • Reverses the elements in the array.

      Returns this

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<bigint>

        A typed or untyped array of values to set.

      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    • Returns a section of an array.

      Parameters

      • Optionalstart: number

        The beginning of the specified portion of the array.

      • Optionalend: number

        The end of the specified portion of the array.

      Returns BigUint64Array<ArrayBuffer>

    • Determines whether the specified callback function returns true for any element of an array.

      Parameters

      • predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<ArrayBufferLike>,
        ) => boolean

        A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns true, or until the end of the array.

      • OptionalthisArg: any

        An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

      Returns boolean

    • Sorts the array.

      Parameters

      • OptionalcompareFn: (a: bigint, b: bigint) => number | bigint

        The function used to determine the order of the elements. If omitted, the elements are sorted in ascending order.

      Returns this

    • Gets a new BigUint64Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      Parameters

      • Optionalbegin: number

        The index of the beginning of the array.

      • Optionalend: number

        The index of the end of the array.

      Returns BigUint64Array<ArrayBufferLike>

    • Converts the array to a string by using the current locale.

      Parameters

      • Optionallocales: string | string[]
      • Optionaloptions: NumberFormatOptions

      Returns string

    • Copies the array and returns the copy with the elements in reverse order.

      Returns BigUint64Array<ArrayBuffer>

    • Copies and sorts the array.

      Parameters

      • OptionalcompareFn: (a: bigint, b: bigint) => number

        Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.

        const myNums = BigUint64Array.from([11n, 2n, 22n, 1n]);
        myNums.toSorted((a, b) => Number(a - b)) // BigUint64Array(4) [1n, 2n, 11n, 22n]

      Returns BigUint64Array<ArrayBuffer>

    • Returns a string representation of the array.

      Returns string

    • Returns the primitive value of the specified object.

      Returns BigUint64Array<ArrayBufferLike>

    • Yields each value in the array.

      Returns ArrayIterator<bigint>

    • Copies the array and inserts the given bigint at the provided index.

      Parameters

      • index: number

        The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.

      • value: bigint

        The value to insert into the copied array.

      Returns BigUint64Array<ArrayBuffer>

      A copy of the original array with the inserted value.

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<bigint>

        An array-like object to convert to an array.

      Returns BigUint64Array<ArrayBuffer>

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • U

      Parameters

      • arrayLike: ArrayLike<U>

        An array-like object to convert to an array.

      • mapfn: (v: U, k: number) => bigint

        A mapping function to call on every element of the array.

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns BigUint64Array<ArrayBuffer>

    • Creates an array from an array-like or iterable object.

      Parameters

      • elements: Iterable<bigint>

        An iterable object to convert to an array.

      Returns BigUint64Array<ArrayBuffer>

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • elements: Iterable<T>

        An iterable object to convert to an array.

      • Optionalmapfn: (v: T, k: number) => bigint

        A mapping function to call on every element of the array.

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns BigUint64Array<ArrayBuffer>

    • Returns a new array from a set of elements.

      Parameters

      • ...items: bigint[]

        A set of elements to include in the new array object.

      Returns BigUint64Array<ArrayBuffer>