MetadataBlock

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

A block of metadata for a single-buffer file system. This metadata maps IDs (for inodes and data) to actual offsets in the buffer. This is done since IDs are not guaranteed to be sequential.

Extends

• Int32Array<ArrayBuffer, this>

Indexable

[index: number]: number

Constructors

Constructor

new MetadataBlock(buffer, byteOffset?, byteLength?): MetadataBlock

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

Parameters

buffer

ArrayBufferLike

byteOffset?

number

byteLength?

number

Returns

MetadataBlock

Inherited from

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

Properties

_previous?

protected optional _previous?: MetadataBlock

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

---

[toStringTag]

readonly [toStringTag]: "Int32Array"

Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:298

Inherited from

$from.typed(Int32Array).[toStringTag]

---

buffer

readonly buffer: ArrayBuffer

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3298

The ArrayBuffer instance referenced by the array.

Inherited from

$from.typed(Int32Array).buffer

---

byteLength

readonly byteLength: number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3303

The length in bytes of the array.

Inherited from

$from.typed(Int32Array).byteLength

---

byteOffset

readonly byteOffset: number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3308

The offset in bytes of the array.

Inherited from

$from.typed(Int32Array).byteOffset

---

BYTES_PER_ELEMENT

readonly BYTES_PER_ELEMENT: number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3293

The size in bytes of each element in the array.

Inherited from

$from.typed(Int32Array).BYTES_PER_ELEMENT

---

constructor

readonly constructor: typeof MetadataBlock

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

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.es5.d.ts:3407

The length of the array.

Inherited from

$from.typed(Int32Array).length

---

alignment

readonly static alignment: number

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

Inherited from

SuperBlock.alignment

---

array?

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

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

Inherited from

$from.typed(Int32Array).array

---

BYTES_PER_ELEMENT?

readonly static optional BYTES_PER_ELEMENT?: number

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

Inherited from

SuperBlock.BYTES_PER_ELEMENT

---

isDynamic?

readonly static optional isDynamic?: boolean

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

Inherited from

SuperBlock.isDynamic

---

isUnion

readonly static isUnion: boolean

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

Inherited from

SuperBlock.isUnion

---

name

static name: string = 'MetadataBlock'

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

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

Overrides

$from.typed(Int32Array).name

---

size

readonly static size: number

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

Inherited from

SuperBlock.size

Accessors

checksum

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

The crc32c checksum for the metadata block.

---

items

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

Metadata entries.

---

locked

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

If non-zero, this block is locked for writing. Note a int32 is used for Atomics.wait

---

previous

Get Signature

get previous(): MetadataBlock | undefined

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

Returns

MetadataBlock | undefined

---

previous_offset

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

Offset to the previous metadata block

---

timestamp

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

The (last) time this metadata block was updated

Methods

[iterator]()

[iterator](): ArrayIterator<number>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:458

Returns

ArrayIterator<number>

Inherited from

$from.typed(Int32Array).[iterator]

---

at()

at(index): number | undefined

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

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

number | undefined

Inherited from

$from.typed(Int32Array).at

---

copyWithin()

copyWithin(target, start, end?): this

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3319

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(Int32Array).copyWithin

---

entries()

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

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:463

Returns an array of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, number]>

Inherited from

$from.typed(Int32Array).entries

---

every()

every(predicate, thisArg?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3329

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

Parameters

predicate

(value, index, array) => unknown

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 a value which is coercible to the Boolean value 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(Int32Array).every

---

fill()

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

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3339

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

Parameters

value

number

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(Int32Array).fill

---

filter()

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

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3348

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

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).filter

---

find()

find(predicate, thisArg?): number | undefined

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3359

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

Parameters

predicate

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

number | undefined

Inherited from

$from.typed(Int32Array).find

---

findIndex()

findIndex(predicate, thisArg?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3370

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

Parameters

predicate

(value, index, obj) => 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(Int32Array).findIndex

---

findLast()

Call Signature

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

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

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

Type Parameters

S

S extends number

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(Int32Array).findLast

Call Signature

findLast(predicate, thisArg?): number | undefined

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

Parameters

predicate

(value, index, array) => unknown

thisArg?

any

Returns

number | undefined

Inherited from

$from.typed(Int32Array).findLast

---

findLastIndex()

findLastIndex(predicate, thisArg?): number

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

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(Int32Array).findLastIndex

---

forEach()

forEach(callbackfn, thisArg?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3379

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(Int32Array).forEach

---

includes()

includes(searchElement, fromIndex?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2016.array.include.d.ts:86

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

Parameters

searchElement

number

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(Int32Array).includes

---

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3387

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

Parameters

searchElement

number

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(Int32Array).indexOf

---

join()

join(separator?): string

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3394

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(Int32Array).join

---

keys()

keys(): ArrayIterator<number>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:468

Returns an list of keys in the array

Returns

ArrayIterator<number>

Inherited from

$from.typed(Int32Array).keys

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3402

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

Parameters

searchElement

number

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(Int32Array).lastIndexOf

---

lock()

lock(): SBLock

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

Returns

SBLock

---

map()

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

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3417

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

Parameters

callbackfn

(value, index, array) => number

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

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).map

---

reduce()

Call Signature

reduce(callbackfn): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3429

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) => number

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

Returns

number

Inherited from

$from.typed(Int32Array).reduce

Call Signature

reduce(callbackfn, initialValue): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3430

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

initialValue

number

Returns

number

Inherited from

$from.typed(Int32Array).reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3442

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(Int32Array).reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3454

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) => number

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

Returns

number

Inherited from

$from.typed(Int32Array).reduceRight

Call Signature

reduceRight(callbackfn, initialValue): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3455

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => number

initialValue

number

Returns

number

Inherited from

$from.typed(Int32Array).reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3467

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(Int32Array).reduceRight

---

reverse()

reverse(): this

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3472

Reverses the elements in an Array.

Returns

this

Inherited from

$from.typed(Int32Array).reverse

---

set()

set(array, offset?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3479

Sets a value or an array of values.

Parameters

array

ArrayLike<number>

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(Int32Array).set

---

slice()

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

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3486

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. This is exclusive of the element at the index ‘end’.

Returns

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).slice

---

some()

some(predicate, thisArg?): boolean

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3496

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

Parameters

predicate

(value, index, array) => unknown

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 a value which is coercible to the Boolean value 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(Int32Array).some

---

sort()

sort(compareFn?): this

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3507

Sorts an array.

Parameters

compareFn?

(a, b) => number

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

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

$from.typed(Int32Array).sort

---

subarray()

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

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3515

Gets a new Int32Array 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

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).subarray

---

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3520

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

Returns

string

Inherited from

$from.typed(Int32Array).toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: ../../node_modules/typescript/lib/lib.es2015.core.d.ts:582

Parameters

locales

string | string[]

options?

NumberFormatOptions

Returns

string

Inherited from

$from.typed(Int32Array).toLocaleString

---

toReversed()

toReversed(): Int32Array<ArrayBuffer>

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

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

Returns

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).toReversed

---

toSorted()

toSorted(compareFn?): Int32Array<ArrayBuffer>

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

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 = Int32Array.from([11, 2, -22, 1]);
myNums.toSorted((a, b) => a - b) // Int32Array(4) [-22, 1, 2, 11]

Returns

Int32Array<ArrayBuffer>

Inherited from

$from.typed(Int32Array).toSorted

---

toString()

toString(long?): string

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

Returns a string representation of an array.

Parameters

long?

boolean = false

Returns

string

Overrides

$from.typed(Int32Array).toString

---

valueOf()

valueOf(): this

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:3528

Returns the primitive value of the specified object.

Returns

this

Inherited from

$from.typed(Int32Array).valueOf

---

values()

values(): ArrayIterator<number>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:473

Returns an list of values in the array

Returns

ArrayIterator<number>

Inherited from

$from.typed(Int32Array).values

---

waitUnlocked()

waitUnlocked(depth?): void

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

Wait for the block to be unlocked.

Parameters

depth?

number = 0

Returns

void

---

with()

with(index, value): Int32Array<ArrayBuffer>

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

Copies the array and inserts the given number 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

number

The value to insert into the copied array.

Returns

Int32Array<ArrayBuffer>

A copy of the original array with the inserted value.

Inherited from

$from.typed(Int32Array).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(Int32Array).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(Int32Array).set