SuperBlock

Defined in: src/backends/single_buffer.ts:173

The super block structure for a single-buffer file system

Extends

• BigUint64Array<ArrayBuffer, this>

Indexable

[index: number]: bigint

Constructors

Constructor

new SuperBlock(…args): SuperBlock

Defined in: src/backends/single_buffer.ts:178

Parameters

args

…[ArrayBufferLike, number, number]

Returns

SuperBlock

Overrides

$from.typed(BigUint64Array)<ArrayBufferLike>.constructor

Properties

[toStringTag]

readonly [toStringTag]: "BigUint64Array"

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:674

Inherited from

$from.typed(BigUint64Array).[toStringTag]

---

buffer

readonly buffer: ArrayBuffer

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:443

The ArrayBuffer instance referenced by the array.

Inherited from

$from.typed(BigUint64Array).buffer

---

byteLength

readonly byteLength: number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:446

The length in bytes of the array.

Inherited from

$from.typed(BigUint64Array).byteLength

---

byteOffset

readonly byteOffset: number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:449

The offset in bytes of the array.

Inherited from

$from.typed(BigUint64Array).byteOffset

---

BYTES_PER_ELEMENT

readonly BYTES_PER_ELEMENT: number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:440

The size in bytes of each element in the array.

Inherited from

$from.typed(BigUint64Array).BYTES_PER_ELEMENT

---

constructor

readonly constructor: typeof SuperBlock

Defined in: src/backends/single_buffer.ts:176

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

---

length

readonly length: number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:559

The length of the array.

Inherited from

$from.typed(BigUint64Array).length

---

metadata

metadata: MetadataBlock

Defined in: src/backends/single_buffer.ts:255

---

alignment

readonly static alignment: number

Defined in: node_modules/memium/dist/structs.shared.d.ts:11

Inherited from

$from.typed(BigUint64Array).alignment

---

array?

readonly static optional array?: TypeArrayConstructor<ArrayBufferView<ArrayBufferLike>>

Defined in: node_modules/memium/dist/types.d.ts:14

Inherited from

$from.typed(BigUint64Array).array

---

BYTES_PER_ELEMENT?

readonly static optional BYTES_PER_ELEMENT?: number

Defined in: node_modules/memium/dist/decorators.d.ts:65

Inherited from

$from.typed(BigUint64Array).BYTES_PER_ELEMENT

---

isDynamic?

readonly static optional isDynamic?: boolean

Defined in: node_modules/memium/dist/structs.shared.d.ts:13

Inherited from

$from.typed(BigUint64Array).isDynamic

---

isUnion

readonly static isUnion: boolean

Defined in: node_modules/memium/dist/structs.shared.d.ts:12

Inherited from

$from.typed(BigUint64Array).isUnion

---

name

static name: string = 'SuperBlock'

Defined in: src/backends/single_buffer.ts:174

Returns the name of the function. Function names are read-only and can not be changed.

Overrides

$from.typed(BigUint64Array).name

---

size

readonly static size: number

Defined in: node_modules/memium/dist/types.d.ts:13

Inherited from

$from.typed(BigUint64Array).size

Accessors

_padding

Defined in: src/backends/single_buffer.ts:261

Padded to 256 bytes

---

checksum

Defined in: src/backends/single_buffer.ts:221

The crc32c checksum for the super block.

---

flags

Defined in: src/backends/single_buffer.ts:233

Flags for the file system. Currently unused

---

inode_format

Defined in: src/backends/single_buffer.ts:230

Which format of Inode is used

---

label

Defined in: src/backends/single_buffer.ts:258

An optional label for the file system

---

magic

Defined in: src/backends/single_buffer.ts:224

Signature for the superblock.

---

metadata_block_size

Defined in: src/backends/single_buffer.ts:248

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

---

metadata_offset

Defined in: src/backends/single_buffer.ts:253

Offset of the current metadata block

---

metadata_offset_

Defined in: src/backends/single_buffer.ts:251

Reserved for 64-bit offset expansion

---

total_bytes

Defined in: src/backends/single_buffer.ts:239

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

---

used_bytes

Defined in: src/backends/single_buffer.ts:236

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

---

uuid

Defined in: src/backends/single_buffer.ts:242

A UUID for this file system

---

version

Defined in: src/backends/single_buffer.ts:227

The version of the on-disk format

Methods

[iterator]()

[iterator](): ArrayIterator<bigint>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:672

Returns

ArrayIterator<bigint>

Inherited from

$from.typed(BigUint64Array).[iterator]

---

at()

at(index): bigint | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2022.array.d.ts:118

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

bigint | undefined

Inherited from

$from.typed(BigUint64Array).at

---

copyWithin()

copyWithin(target, start, end?): this

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:460

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.

end?

number

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

Returns

this

Inherited from

$from.typed(BigUint64Array).copyWithin

---

entries()

entries(): ArrayIterator<[number, bigint]>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:463

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

Returns

ArrayIterator<[number, bigint]>

Inherited from

$from.typed(BigUint64Array).entries

---

every()

every(predicate, thisArg?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:473

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

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

Inherited from

$from.typed(BigUint64Array).every

---

fill()

fill(value, start?, end?): this

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:483

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

start?

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.

end?

number

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

Returns

this

Inherited from

$from.typed(BigUint64Array).fill

---

filter()

filter(predicate, thisArg?): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:492

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

Parameters

predicate

(value, index, array) => any

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

thisArg?

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>

Inherited from

$from.typed(BigUint64Array).filter

---

find()

find(predicate, thisArg?): bigint | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:503

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

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

bigint | undefined

Inherited from

$from.typed(BigUint64Array).find

---

findIndex()

findIndex(predicate, thisArg?): number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:514

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

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

Inherited from

$from.typed(BigUint64Array).findIndex

---

findLast()

Call Signature

findLast<S>(predicate, thisArg?): S | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:862

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

Type Parameters

S

S extends bigint

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

S | undefined

Inherited from

$from.typed(BigUint64Array).findLast

Call Signature

findLast(predicate, thisArg?): bigint | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:870

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

bigint | undefined

Inherited from

$from.typed(BigUint64Array).findLast

---

findLastIndex()

findLastIndex(predicate, thisArg?): number

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:888

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

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

Inherited from

$from.typed(BigUint64Array).findLastIndex

---

forEach()

forEach(callbackfn, thisArg?): void

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:523

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

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

thisArg?

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

Inherited from

$from.typed(BigUint64Array).forEach

---

includes()

includes(searchElement, fromIndex?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:530

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

Parameters

searchElement

bigint

The element to search for.

fromIndex?

number

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

Returns

boolean

Inherited from

$from.typed(BigUint64Array).includes

---

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:538

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

bigint

The value to locate in the array.

fromIndex?

number

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

Returns

number

Inherited from

$from.typed(BigUint64Array).indexOf

---

isUnused()

isUnused(offset, length): boolean

Defined in: src/backends/single_buffer.ts:311

Internal

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

Parameters

offset

number

length

number

Returns

boolean

---

join()

join(separator?): string

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:545

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

Parameters

separator?

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

Inherited from

$from.typed(BigUint64Array).join

---

keys()

keys(): ArrayIterator<number>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:548

Yields each index in the array.

Returns

ArrayIterator<number>

Inherited from

$from.typed(BigUint64Array).keys

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:556

Returns the index of the last occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

bigint

The value to locate in the array.

fromIndex?

number

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

Returns

number

Inherited from

$from.typed(BigUint64Array).lastIndexOf

---

map()

map(callbackfn, thisArg?): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:569

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

Parameters

callbackfn

(value, index, array) => bigint

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

thisArg?

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>

Inherited from

$from.typed(BigUint64Array).map

---

reduce()

Call Signature

reduce(callbackfn): bigint

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:581

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, currentValue, currentIndex, array) => 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

Inherited from

$from.typed(BigUint64Array).reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:593

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

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => 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

Inherited from

$from.typed(BigUint64Array).reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn): bigint

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:605

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, currentValue, currentIndex, array) => 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

Inherited from

$from.typed(BigUint64Array).reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:617

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

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => 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

Inherited from

$from.typed(BigUint64Array).reduceRight

---

reverse()

reverse(): this

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:620

Reverses the elements in the array.

Returns

this

Inherited from

$from.typed(BigUint64Array).reverse

---

rotateMetadata()

rotateMetadata(): MetadataBlock

Defined in: src/backends/single_buffer.ts:269

Rotate out the current metadata block. Allocates a new metadata block, moves the current one to backup, and updates used_bytes accordingly.

Returns

MetadataBlock

the new metadata block

---

set()

set(array, offset?): void

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:627

Sets a value or an array of values.

Parameters

array

ArrayLike<bigint>

A typed or untyped array of values to set.

offset?

number

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

Returns

void

Inherited from

$from.typed(BigUint64Array).set

---

slice()

slice(start?, end?): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:634

Returns a section of an array.

Parameters

start?

number

The beginning of the specified portion of the array.

end?

number

The end of the specified portion of the array.

Returns

BigUint64Array<ArrayBuffer>

Inherited from

$from.typed(BigUint64Array).slice

---

some()

some(predicate, thisArg?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:644

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

Parameters

predicate

(value, index, array) => 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.

thisArg?

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

Inherited from

$from.typed(BigUint64Array).some

---

sort()

sort(compareFn?): this

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:650

Sorts the array.

Parameters

compareFn?

(a, b) => number | bigint

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

Returns

this

Inherited from

$from.typed(BigUint64Array).sort

---

subarray()

subarray(begin?, end?): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:658

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

Parameters

begin?

number

The index of the beginning of the array.

end?

number

The index of the end of the array.

Returns

BigUint64Array<ArrayBuffer>

Inherited from

$from.typed(BigUint64Array).subarray

---

toLocaleString()

toLocaleString(locales?, options?): string

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:661

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

Parameters

locales?

string | string[]

options?

NumberFormatOptions

Returns

string

Inherited from

$from.typed(BigUint64Array).toLocaleString

---

toReversed()

toReversed(): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:900

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

Returns

BigUint64Array<ArrayBuffer>

Inherited from

$from.typed(BigUint64Array).toReversed

---

toSorted()

toSorted(compareFn?): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:912

Copies and sorts the array.

Parameters

compareFn?

(a, b) => 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>

Inherited from

$from.typed(BigUint64Array).toSorted

---

toString()

toString(): string

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:664

Returns a string representation of the array.

Returns

string

Inherited from

$from.typed(BigUint64Array).toString

---

valueOf()

valueOf(): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:667

Returns the primitive value of the specified object.

Returns

BigUint64Array<ArrayBuffer>

Inherited from

$from.typed(BigUint64Array).valueOf

---

values()

values(): ArrayIterator<bigint>

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:670

Yields each value in the array.

Returns

ArrayIterator<bigint>

Inherited from

$from.typed(BigUint64Array).values

---

with()

with(index, value): BigUint64Array<ArrayBuffer>

Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:921

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.

Inherited from

$from.typed(BigUint64Array).with

---

get()

static get(this, buffer, offset): ArrayBufferView

Defined in: node_modules/memium/dist/types.d.ts:17

Get a value from a buffer

Parameters

this

void

buffer

ArrayBufferLike

offset

number

Returns

ArrayBufferView

Inherited from

$from.typed(BigUint64Array).get

---

set()

static set(this, buffer, offset, value): void

Defined in: node_modules/memium/dist/types.d.ts:19

Set a value in a buffer

Parameters

this

void

buffer

ArrayBufferLike

offset

number

value

ArrayBufferView

Returns

void

Inherited from

$from.typed(BigUint64Array).set