LocalFileHeader
Defined in: src/zip/zip.ts:50
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.3.7
Extends
Section titled “Extends”Uint8Array<ArrayBuffer,this>
Type Parameters
Section titled “Type Parameters”TBuffer
Section titled “TBuffer”TBuffer extends ArrayBufferLike = ArrayBuffer
Indexable
Section titled “Indexable”[
index:number]:number
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LocalFileHeader<
TBuffer>(buffer,byteOffset?,byteLength?):LocalFileHeader
Defined in: node_modules/memium/dist/decorators.d.ts:62
Parameters
Section titled “Parameters”buffer
Section titled “buffer”TBuffer
byteOffset?
Section titled “byteOffset?”number
byteLength?
Section titled “byteLength?”number
Returns
Section titled “Returns”LocalFileHeader
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array)<TBuffer>.constructor
Properties
Section titled “Properties”[toStringTag]
Section titled “[toStringTag]”
readonly[toStringTag]:"Uint8Array"
Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:282
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).[toStringTag]
buffer
Section titled “buffer”
readonlybuffer:ArrayBuffer
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2172
The ArrayBuffer instance referenced by the array.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).buffer
byteLength
Section titled “byteLength”
readonlybyteLength:number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2177
The length in bytes of the array.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).byteLength
byteOffset
Section titled “byteOffset”
readonlybyteOffset:number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2182
The offset in bytes of the array.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).byteOffset
BYTES_PER_ELEMENT
Section titled “BYTES_PER_ELEMENT”
readonlyBYTES_PER_ELEMENT:number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2167
The size in bytes of each element in the array.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).BYTES_PER_ELEMENT
length
Section titled “length”
readonlylength:number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2281
The length of the array.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).length
alignment
Section titled “alignment”
readonlystaticalignment:number
Defined in: node_modules/memium/dist/structs.shared.d.ts:11
Inherited from
Section titled “Inherited from”array?
Section titled “array?”
readonlystaticoptionalarray?:TypeArrayConstructor<ArrayBufferView<ArrayBufferLike>>
Defined in: node_modules/memium/dist/types.d.ts:14
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).array
BYTES_PER_ELEMENT?
Section titled “BYTES_PER_ELEMENT?”
readonlystaticoptionalBYTES_PER_ELEMENT?:number
Defined in: node_modules/memium/dist/decorators.d.ts:65
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).BYTES_PER_ELEMENT
isDynamic?
Section titled “isDynamic?”
readonlystaticoptionalisDynamic?:boolean
Defined in: node_modules/memium/dist/structs.shared.d.ts:13
Inherited from
Section titled “Inherited from”isUnion
Section titled “isUnion”
readonlystaticisUnion:boolean
Defined in: node_modules/memium/dist/structs.shared.d.ts:12
Inherited from
Section titled “Inherited from”
staticname:string='LocalFileHeader'
Defined in: src/zip/zip.ts:51
Returns the name of the function. Function names are read-only and can not be changed.
Overrides
Section titled “Overrides”
readonlystaticsize:number
Defined in: node_modules/memium/dist/types.d.ts:13
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Defined in: src/zip/zip.ts:134
Get Signature
Section titled “Get Signature”get $size():
number
Defined in: src/zip/zip.ts:156
Returns
Section titled “Returns”number
compressedSize
Section titled “compressedSize”Defined in: src/zip/zip.ts:112
The size of the file compressed. If bit 3 of the general purpose bit flag is set, set to zero. central directory’s entry is used
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.8
compressionMethod
Section titled “compressionMethod”Defined in: src/zip/zip.ts:76
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.5
Defined in: src/zip/zip.ts:104
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.7
datetime
Section titled “datetime”Defined in: src/zip/zip.ts:81
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.6
Defined in: src/zip/zip.ts:152
This should be used for storage expansion.
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.28
extraLength
Section titled “extraLength”Defined in: src/zip/zip.ts:132
The length of the extra field
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.11
Defined in: src/zip/zip.ts:71
General purpose bit flags
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.4
lastModified
Section titled “lastModified”Get Signature
Section titled “Get Signature”get lastModified():
Date
Defined in: src/zip/zip.ts:88
The date and time are encoded in standard MS-DOS format. This getter decodes the date.
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.6
Returns
Section titled “Returns”Date
Set Signature
Section titled “Set Signature”set lastModified(
value):void
Defined in: src/zip/zip.ts:97
The date and time are encoded in standard MS-DOS format. This getter decodes the date.
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.6
Parameters
Section titled “Parameters”Date
Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get name():
string
Defined in: src/zip/zip.ts:143
The name of the file, with optional relative path.
- CentralDirectory.fileName
- http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.17
Returns
Section titled “Returns”string
nameLength
Section titled “nameLength”Defined in: src/zip/zip.ts:126
The length of the file name
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.10
signature
Section titled “signature”Defined in: src/zip/zip.ts:53
uncompressedSize
Section titled “uncompressedSize”Defined in: src/zip/zip.ts:120
The size of the file uncompressed If bit 3 of the general purpose bit flag is set, set to zero. central directory’s entry is used
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.9
useUTF8
Section titled “useUTF8”Get Signature
Section titled “Get Signature”get useUTF8():
boolean
Defined in: src/zip/zip.ts:161
Returns
Section titled “Returns”boolean
versionNeeded
Section titled “versionNeeded”Defined in: src/zip/zip.ts:65
The minimum supported ZIP specification version needed to extract the file.
http://pkware.com/documents/casestudies/APPNOTE.TXT#:~:text=4.4.3
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
ArrayIterator<number>
Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:311
Returns
Section titled “Returns”ArrayIterator<number>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).[iterator]
at(
index):number|undefined
Defined in: ../../node_modules/typescript/lib/lib.es2022.array.d.ts:46
Returns the item located at the specified index.
Parameters
Section titled “Parameters”number
The zero-based index of the desired code unit. A negative index will count back from the last item.
Returns
Section titled “Returns”number | undefined
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).at
check()
Section titled “check()”check():
void
Defined in: src/zip/zip.ts:55
Returns
Section titled “Returns”void
copyWithin()
Section titled “copyWithin()”copyWithin(
target,start,end?):this
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2193
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”target
Section titled “target”number
If target is negative, it is treated as length+target where length is the length of the array.
number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+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”$from.typed(Uint8Array).copyWithin
entries()
Section titled “entries()”entries():
ArrayIterator<[number,number]>
Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:316
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”$from.typed(Uint8Array).entries
every()
Section titled “every()”every(
predicate,thisArg?):boolean
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2203
Determines whether all the members of an array satisfy the specified test.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”$from.typed(Uint8Array).every
fill()
Section titled “fill()”fill(
value,start?,end?):this
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2213
Changes all array elements from start to end index to a static value and returns the modified array
Parameters
Section titled “Parameters”number
value to fill array section with
start?
Section titled “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.
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”$from.typed(Uint8Array).fill
filter()
Section titled “filter()”filter(
predicate,thisArg?):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2222
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).filter
find()
Section titled “find()”find(
predicate,thisArg?):number|undefined
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2233
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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 | undefined
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).find
findIndex()
Section titled “findIndex()”findIndex(
predicate,thisArg?):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2244
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”$from.typed(Uint8Array).findIndex
findLast()
Section titled “findLast()”Call Signature
Section titled “Call Signature”findLast<
S>(predicate,thisArg?):S|undefined
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:238
Returns the value of the last element in the array where predicate is true, and undefined otherwise.
Type Parameters
Section titled “Type Parameters”S extends number
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”S | undefined
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).findLast
Call Signature
Section titled “Call Signature”findLast(
predicate,thisArg?):number|undefined
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:246
Parameters
Section titled “Parameters”predicate
Section titled “predicate”(value, index, array) => unknown
thisArg?
Section titled “thisArg?”any
Returns
Section titled “Returns”number | undefined
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).findLast
findLastIndex()
Section titled “findLastIndex()”findLastIndex(
predicate,thisArg?):number
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:260
Returns the index of the last element in the array where predicate is true, and -1 otherwise.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”$from.typed(Uint8Array).findLastIndex
forEach()
Section titled “forEach()”forEach(
callbackfn,thisArg?):void
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2253
Performs the specified action for each element in an array.
Parameters
Section titled “Parameters”callbackfn
Section titled “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?
Section titled “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”$from.typed(Uint8Array).forEach
includes()
Section titled “includes()”includes(
searchElement,fromIndex?):boolean
Defined in: ../../node_modules/typescript/lib/lib.es2016.array.include.d.ts:50
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
Section titled “Parameters”searchElement
Section titled “searchElement”number
The element to search for.
fromIndex?
Section titled “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”$from.typed(Uint8Array).includes
indexOf()
Section titled “indexOf()”indexOf(
searchElement,fromIndex?):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2261
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Parameters
Section titled “Parameters”searchElement
Section titled “searchElement”number
The value to locate in the array.
fromIndex?
Section titled “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”$from.typed(Uint8Array).indexOf
join()
Section titled “join()”join(
separator?):string
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2268
Adds all the elements of an array separated by the specified separator string.
Parameters
Section titled “Parameters”separator?
Section titled “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”$from.typed(Uint8Array).join
keys()
Section titled “keys()”keys():
ArrayIterator<number>
Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:321
Returns an list of keys in the array
Returns
Section titled “Returns”ArrayIterator<number>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).keys
lastIndexOf()
Section titled “lastIndexOf()”lastIndexOf(
searchElement,fromIndex?):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2276
Returns the index of the last occurrence of a value in an array, or -1 if it is not present.
Parameters
Section titled “Parameters”searchElement
Section titled “searchElement”number
The value to locate in the array.
fromIndex?
Section titled “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”$from.typed(Uint8Array).lastIndexOf
map(
callbackfn,thisArg?):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2291
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
Section titled “Parameters”callbackfn
Section titled “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?
Section titled “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”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).map
reduce()
Section titled “reduce()”Call Signature
Section titled “Call Signature”reduce(
callbackfn):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2303
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”callbackfn
Section titled “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”$from.typed(Uint8Array).reduce
Call Signature
Section titled “Call Signature”reduce(
callbackfn,initialValue):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2304
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue, currentValue, currentIndex, array) => number
initialValue
Section titled “initialValue”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).reduce
Call Signature
Section titled “Call Signature”reduce<
U>(callbackfn,initialValue):U
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2316
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”U
Parameters
Section titled “Parameters”callbackfn
Section titled “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
Section titled “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”$from.typed(Uint8Array).reduce
reduceRight()
Section titled “reduceRight()”Call Signature
Section titled “Call Signature”reduceRight(
callbackfn):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2328
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”callbackfn
Section titled “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”$from.typed(Uint8Array).reduceRight
Call Signature
Section titled “Call Signature”reduceRight(
callbackfn,initialValue):number
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2329
Parameters
Section titled “Parameters”callbackfn
Section titled “callbackfn”(previousValue, currentValue, currentIndex, array) => number
initialValue
Section titled “initialValue”number
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).reduceRight
Call Signature
Section titled “Call Signature”reduceRight<
U>(callbackfn,initialValue):U
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2341
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”U
Parameters
Section titled “Parameters”callbackfn
Section titled “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
Section titled “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”$from.typed(Uint8Array).reduceRight
reverse()
Section titled “reverse()”reverse():
this
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2346
Reverses the elements in an Array.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).reverse
set(
array,offset?):void
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2353
Sets a value or an array of values.
Parameters
Section titled “Parameters”ArrayLike<number>
A typed or untyped array of values to set.
offset?
Section titled “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”$from.typed(Uint8Array).set
setFromBase64()
Section titled “setFromBase64()”setFromBase64(
string,options?):object
Defined in: ../../node_modules/typescript/lib/lib.esnext.typedarrays.d.ts:38
Sets the Uint8Array from a base64-encoded string.
Parameters
Section titled “Parameters”string
Section titled “string”string
The base64-encoded string.
options?
Section titled “options?”If provided, specifies the alphabet and handling of the last chunk.
alphabet?
Section titled “alphabet?”"base64" | "base64url"
lastChunkHandling?
Section titled “lastChunkHandling?”"loose" | "strict" | "stop-before-partial"
Returns
Section titled “Returns”object
An object containing the number of bytes read and written.
read:
number
written
Section titled “written”written:
number
Throws
Section titled “Throws”If the input string contains characters outside the specified alphabet, or if the last
chunk is inconsistent with the lastChunkHandling option.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).setFromBase64
setFromHex()
Section titled “setFromHex()”setFromHex(
string):object
Defined in: ../../node_modules/typescript/lib/lib.esnext.typedarrays.d.ts:60
Sets the Uint8Array from a base16-encoded string.
Parameters
Section titled “Parameters”string
Section titled “string”string
The base16-encoded string.
Returns
Section titled “Returns”object
An object containing the number of bytes read and written.
read:
number
written
Section titled “written”written:
number
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).setFromHex
slice()
Section titled “slice()”slice(
start?,end?):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2360
Returns a section of an array.
Parameters
Section titled “Parameters”start?
Section titled “start?”number
The beginning of the specified portion of the array.
number
The end of the specified portion of the array. This is exclusive of the element at the index ‘end’.
Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).slice
some()
Section titled “some()”some(
predicate,thisArg?):boolean
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2370
Determines whether the specified callback function returns true for any element of an array.
Parameters
Section titled “Parameters”predicate
Section titled “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?
Section titled “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”$from.typed(Uint8Array).some
sort()
Section titled “sort()”sort(
compareFn?):this
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2381
Sorts an array.
Parameters
Section titled “Parameters”compareFn?
Section titled “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”$from.typed(Uint8Array).sort
subarray()
Section titled “subarray()”subarray(
begin?,end?):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2389
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”begin?
Section titled “begin?”number
The index of the beginning of the array.
number
The index of the end of the array.
Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).subarray
toBase64()
Section titled “toBase64()”toBase64(
options?):string
Defined in: ../../node_modules/typescript/lib/lib.esnext.typedarrays.d.ts:23
Converts the Uint8Array to a base64-encoded string.
Parameters
Section titled “Parameters”options?
Section titled “options?”If provided, sets the alphabet and padding behavior used.
alphabet?
Section titled “alphabet?”"base64" | "base64url"
omitPadding?
Section titled “omitPadding?”boolean
Returns
Section titled “Returns”string
A base64-encoded string.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toBase64
toHex()
Section titled “toHex()”toHex():
string
Defined in: ../../node_modules/typescript/lib/lib.esnext.typedarrays.d.ts:53
Converts the Uint8Array to a base16-encoded string.
Returns
Section titled “Returns”string
A base16-encoded string.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toHex
toLocaleString()
Section titled “toLocaleString()”Call Signature
Section titled “Call Signature”toLocaleString():
string
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2394
Converts a number to a string by using the current locale.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toLocaleString
Call Signature
Section titled “Call Signature”toLocaleString(
locales,options?):string
Defined in: ../../node_modules/typescript/lib/lib.es2015.core.d.ts:566
Parameters
Section titled “Parameters”locales
Section titled “locales”string | string[]
options?
Section titled “options?”NumberFormatOptions
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toLocaleString
toReversed()
Section titled “toReversed()”toReversed():
Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:268
Copies the array and returns the copy with the elements in reverse order.
Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toReversed
toSorted()
Section titled “toSorted()”toSorted(
compareFn?):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:280
Copies and sorts the array.
Parameters
Section titled “Parameters”compareFn?
Section titled “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 = Uint8Array.from([11, 2, 22, 1]);myNums.toSorted((a, b) => a - b) // Uint8Array(4) [1, 2, 11, 22]Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toSorted
toString()
Section titled “toString()”toString():
string
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2399
Returns a string representation of an array.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).toString
valueOf()
Section titled “valueOf()”valueOf():
this
Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:2402
Returns the primitive value of the specified object.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).valueOf
values()
Section titled “values()”values():
ArrayIterator<number>
Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:326
Returns an list of values in the array
Returns
Section titled “Returns”ArrayIterator<number>
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).values
with()
Section titled “with()”with(
index,value):Uint8Array<ArrayBuffer>
Defined in: ../../node_modules/typescript/lib/lib.es2023.array.d.ts:289
Copies the array and inserts the given number at the provided index.
Parameters
Section titled “Parameters”number
The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
number
The value to insert into the copied array.
Returns
Section titled “Returns”Uint8Array<ArrayBuffer>
A copy of the original array with the inserted value.
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).with
staticget(this,buffer,offset):ArrayBufferView
Defined in: node_modules/memium/dist/types.d.ts:17
Get a value from a buffer
Parameters
Section titled “Parameters”void
buffer
Section titled “buffer”ArrayBufferLike
offset
Section titled “offset”number
Returns
Section titled “Returns”ArrayBufferView
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).get
staticset(this,buffer,offset,value):void
Defined in: node_modules/memium/dist/types.d.ts:19
Set a value in a buffer
Parameters
Section titled “Parameters”void
buffer
Section titled “buffer”ArrayBufferLike
offset
Section titled “offset”number
ArrayBufferView
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”$from.typed(Uint8Array).set