ByteView
Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/block/interface.d.ts:12
A byte-encoded representation of some type of Data
.
A ByteView
is essentially a Uint8Array
that’s been “tagged” with
a Data
type parameter indicating the type of encoded data.
For example, a ByteView<{ hello: "world" }>
is a Uint8Array
containing a
binary representation of a {hello: "world"}
.
Extends
Section titled “Extends”Uint8Array
.Phantom
<Data
>
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
Data |
Indexable
Section titled “Indexable”[index: number]: number
Properties
Section titled “Properties”[Marker]?
Section titled “[Marker]?”optional [Marker]: Data;
Defined in: node_modules/.pnpm/multiformats@13.4.1/node_modules/multiformats/dist/src/block/interface.d.ts:33
Inherited from
Section titled “Inherited from”[toStringTag]
Section titled “[toStringTag]”readonly [toStringTag]: "Uint8Array";
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:284
Inherited from
Section titled “Inherited from”buffer
Section titled “buffer”readonly buffer: ArrayBufferLike;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2174
The ArrayBuffer instance referenced by the array.
Inherited from
Section titled “Inherited from”Uint8Array.buffer
byteLength
Section titled “byteLength”readonly byteLength: number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2179
The length in bytes of the array.
Inherited from
Section titled “Inherited from”byteOffset
Section titled “byteOffset”readonly byteOffset: number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2184
The offset in bytes of the array.
Inherited from
Section titled “Inherited from”BYTES_PER_ELEMENT
Section titled “BYTES_PER_ELEMENT”readonly BYTES_PER_ELEMENT: number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2169
The size in bytes of each element in the array.
Inherited from
Section titled “Inherited from”length
Section titled “length”readonly length: number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2283
The length of the array.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”iterator: ArrayIterator<number>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:313
Returns
Section titled “Returns”ArrayIterator
<number
>
Inherited from
Section titled “Inherited from”Uint8Array.[iterator]
at(index): undefined | number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.array.d.ts:48
Returns the item located at the specified index.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
index | number | The zero-based index of the desired code unit. A negative index will count back from the last item. |
Returns
Section titled “Returns”undefined
| number
Inherited from
Section titled “Inherited from”Uint8Array.at
copyWithin()
Section titled “copyWithin()”copyWithin( target, start, end?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2195
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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Uint8Array.copyWithin
entries()
Section titled “entries()”entries(): ArrayIterator<[number, number]>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:318
Returns an array of key, value pairs for every entry in the array
Returns
Section titled “Returns”ArrayIterator
<[number
, number
]>
Inherited from
Section titled “Inherited from”Uint8Array.entries
every()
Section titled “every()”every(predicate, thisArg?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2205
Determines whether all the members of an array satisfy the specified test.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Uint8Array.every
fill()
Section titled “fill()”fill( value, start?, end?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2215
Changes all array elements from start
to end
index to a static value
and returns the modified array
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Uint8Array.fill
filter()
Section titled “filter()”filter(predicate, thisArg?): Uint8Array<ArrayBuffer>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2224
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”Inherited from
Section titled “Inherited from”Uint8Array.filter
find()
Section titled “find()”find(predicate, thisArg?): undefined | number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2235
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”undefined
| number
Inherited from
Section titled “Inherited from”Uint8Array.find
findIndex()
Section titled “findIndex()”findIndex(predicate, thisArg?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2246
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.findIndex
forEach()
Section titled “forEach()”forEach(callbackfn, thisArg?): void;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2255
Performs the specified action for each element in an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Uint8Array.forEach
includes()
Section titled “includes()”includes(searchElement, fromIndex?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:52
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
searchElement | number | The element to search for. |
fromIndex? | number | The position in this array at which to begin searching for searchElement. |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Uint8Array.includes
indexOf()
Section titled “indexOf()”indexOf(searchElement, fromIndex?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2263
Returns the index of the first occurrence of a value in an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.indexOf
join()
Section titled “join()”join(separator?): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2270
Adds all the elements of an array separated by the specified separator string.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Uint8Array.join
keys()
Section titled “keys()”keys(): ArrayIterator<number>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:323
Returns an list of keys in the array
Returns
Section titled “Returns”ArrayIterator
<number
>
Inherited from
Section titled “Inherited from”Uint8Array.keys
lastIndexOf()
Section titled “lastIndexOf()”lastIndexOf(searchElement, fromIndex?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2278
Returns the index of the last occurrence of a value in an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.lastIndexOf
map(callbackfn, thisArg?): Uint8Array<ArrayBuffer>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2293
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”Inherited from
Section titled “Inherited from”Uint8Array.map
reduce()
Section titled “reduce()”Call Signature
Section titled “Call Signature”reduce(callbackfn): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2305
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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.reduce
Call Signature
Section titled “Call Signature”reduce(callbackfn, initialValue): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2306
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => number |
initialValue | number |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.reduce
Call Signature
Section titled “Call Signature”reduce<U>(callbackfn, initialValue): U;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2318
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
Section titled “Type Parameters”Type Parameter |
---|
U |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Uint8Array.reduce
reduceRight()
Section titled “reduceRight()”Call Signature
Section titled “Call Signature”reduceRight(callbackfn): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2330
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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.reduceRight
Call Signature
Section titled “Call Signature”reduceRight(callbackfn, initialValue): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2331
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => number |
initialValue | number |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Uint8Array.reduceRight
Call Signature
Section titled “Call Signature”reduceRight<U>(callbackfn, initialValue): U;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2343
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
Section titled “Type Parameters”Type Parameter |
---|
U |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Uint8Array.reduceRight
reverse()
Section titled “reverse()”reverse(): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2348
Reverses the elements in an Array.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Uint8Array.reverse
set(array, offset?): void;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2355
Sets a value or an array of values.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Uint8Array.set
slice()
Section titled “slice()”slice(start?, end?): Uint8Array<ArrayBuffer>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2362
Returns a section of an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”Inherited from
Section titled “Inherited from”Uint8Array.slice
some()
Section titled “some()”some(predicate, thisArg?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2372
Determines whether the specified callback function returns true for any element of an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Uint8Array.some
sort()
Section titled “sort()”sort(compareFn?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2383
Sorts an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Uint8Array.sort
subarray()
Section titled “subarray()”subarray(begin?, end?): Uint8Array<ArrayBufferLike>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2391
Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
begin? | number | The index of the beginning of the array. |
end? | number | The index of the end of the array. |
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Uint8Array.subarray
toLocaleString()
Section titled “toLocaleString()”Call Signature
Section titled “Call Signature”toLocaleString(): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2396
Converts a number to a string by using the current locale.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Uint8Array.toLocaleString
Call Signature
Section titled “Call Signature”toLocaleString(locales, options?): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:568
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
locales | string | string [] |
options? | NumberFormatOptions |
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Uint8Array.toLocaleString
toString()
Section titled “toString()”toString(): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2401
Returns a string representation of an array.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Uint8Array.toString
valueOf()
Section titled “valueOf()”valueOf(): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:2404
Returns the primitive value of the specified object.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Uint8Array.valueOf
values()
Section titled “values()”values(): ArrayIterator<number>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:328
Returns an list of values in the array
Returns
Section titled “Returns”ArrayIterator
<number
>
Inherited from
Section titled “Inherited from”Uint8Array.values