TypedArray<TType, TFixedLength> Interface

    Package: @esfx/struct-type
    Declaration
    export interface TypedArray<TType extends Type, TFixedLength extends number = number> 

    Properties

    buffer

    Declaration
    readonly buffer: ArrayBufferLike;
    Property Value
    ArrayBufferLike

    byteLength

    Declaration
    readonly byteLength: number;
    Property Value
    number

    byteOffset

    Declaration
    readonly byteOffset: number;
    Property Value
    number

    length

    Declaration
    readonly length: TFixedLength;
    Property Value
    TFixedLength

    Methods

    [Symbol.iterator]()

    Declaration
    [Symbol.iterator](): IterableIterator<RuntimeType<TType>>;
    Returns
    IterableIterator<RuntimeType<TType>>

    at(index)

    Declaration
    at(index: number): RuntimeType<TType> | undefined;
    Parameters
    index
    number

    Returns
    RuntimeType<TType> | undefined

    copyWithin(target, start, end)

    Declaration
    copyWithin(target: number, start: number, end?: number): this;
    Parameters
    target
    number

    start
    number

    end
    number

    Returns
    this

    entries()

    Declaration
    entries(): IterableIterator<[number, RuntimeType<TType>]>;
    Returns
    IterableIterator<[number, RuntimeType<TType>]>

    every(predicate)

    Declaration
    every(predicate: (value: RuntimeType<TType>, index: number) => unknown): boolean;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    Returns
    boolean

    fill(value, start, end)

    Declaration
    fill(value: RuntimeType<TType>, start?: number, end?: number): this;
    Parameters
    value
    RuntimeType<TType>

    start
    number

    end
    number

    Returns
    this

    filter(predicate)

    Declaration
    filter(predicate: (value: RuntimeType<TType>, index: number) => unknown): TypedArray<TType>;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    Returns
    TypedArray<TType>

    find(predicate, fromIndex)

    Declaration
    find(predicate: (value: RuntimeType<TType>, index: number) => unknown, fromIndex?: number): RuntimeType<TType> | undefined;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    fromIndex
    number

    Returns
    RuntimeType<TType> | undefined

    findIndex(predicate, fromIndex)

    Declaration
    findIndex(predicate: (value: RuntimeType<TType>, index: number) => unknown, fromIndex?: number): number;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    fromIndex
    number

    Returns
    number

    findLast(predicate, fromIndex)

    Declaration
    findLast(predicate: (value: RuntimeType<TType>, index: number) => unknown, fromIndex?: number): RuntimeType<TType> | undefined;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    fromIndex
    number

    Returns
    RuntimeType<TType> | undefined

    findLastIndex(predicate, fromIndex)

    Declaration
    findLastIndex(predicate: (value: RuntimeType<TType>, index: number) => unknown, fromIndex?: number): number;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    fromIndex
    number

    Returns
    number

    forEach(callbackfn)

    Declaration
    forEach(callbackfn: (value: RuntimeType<TType>, index: number) => void): void;
    Parameters
    callbackfn
    (value: RuntimeType<TType>, index: number) => void

    Returns
    void

    keys()

    Declaration
    keys(): IterableIterator<number>;
    Returns
    IterableIterator<number>

    map(callbackfn)

    Declaration
    map(callbackfn: (value: RuntimeType<TType>, index: number) => RuntimeType<TType>): TypedArray<TType, TFixedLength>;
    Parameters
    callbackfn
    (value: RuntimeType<TType>, index: number) => RuntimeType<TType>

    Returns
    TypedArray<TType, TFixedLength>

    mapToArray(callbackfn)

    Declaration
    mapToArray<U>(callbackfn: (value: RuntimeType<TType>, index: number) => U): U[];
    Type Parameters
    U

    Parameters
    callbackfn
    (value: RuntimeType<TType>, index: number) => U

    Returns
    U[]

    reduce(callbackfn)

    Declaration
    reduce(callbackfn: (previousValue: RuntimeType<TType>, value: RuntimeType<TType>, index: number) => RuntimeType<TType>): RuntimeType<TType>;
    Parameters
    callbackfn
    (previousValue: RuntimeType<TType>, value: RuntimeType<TType>, index: number) => RuntimeType<TType>

    Returns
    RuntimeType<TType>

    reduce(callbackfn, initialValue)

    Declaration
    reduce<U>(callbackfn: (previousValue: U, value: RuntimeType<TType>, index: number) => U, initialValue: U): U;
    Type Parameters
    U

    Parameters
    callbackfn
    (previousValue: U, value: RuntimeType<TType>, index: number) => U

    initialValue
    U

    Returns
    U

    reduceRight(callbackfn)

    Declaration
    reduceRight(callbackfn: (previousValue: RuntimeType<TType>, value: RuntimeType<TType>, index: number) => RuntimeType<TType>): RuntimeType<TType>;
    Parameters
    callbackfn
    (previousValue: RuntimeType<TType>, value: RuntimeType<TType>, index: number) => RuntimeType<TType>

    Returns
    RuntimeType<TType>

    reduceRight(callbackfn, initialValue)

    Declaration
    reduceRight<U>(callbackfn: (previousValue: U, value: RuntimeType<TType>, index: number) => U, initialValue: U): U;
    Type Parameters
    U

    Parameters
    callbackfn
    (previousValue: U, value: RuntimeType<TType>, index: number) => U

    initialValue
    U

    Returns
    U

    set(array, offset)

    Declaration
    set(array: ArrayLike<RuntimeType<TType>>, offset?: number): void;
    Parameters
    array
    ArrayLike<RuntimeType<TType>>

    offset
    number

    Returns
    void

    slice(start, end)

    Declaration
    slice(start?: number, end?: number): TypedArray<TType>;
    Parameters
    start
    number

    end
    number

    Returns
    TypedArray<TType>

    some(predicate)

    Declaration
    some(predicate: (value: RuntimeType<TType>, index: number) => unknown): boolean;
    Parameters
    predicate
    (value: RuntimeType<TType>, index: number) => unknown

    Returns
    boolean

    subarray(start, end)

    Declaration
    subarray(start?: number, end?: number): TypedArray<TType>;
    Parameters
    start
    number

    end
    number

    Returns
    TypedArray<TType>

    toArray()

    Declaration
    toArray(): RuntimeType<TType>[];
    Returns
    RuntimeType<TType>[]

    values()

    Declaration
    values(): IterableIterator<RuntimeType<TType>>;
    Returns
    IterableIterator<RuntimeType<TType>>

    writeTo(buffer, byteOffset, byteOrder)

    Declaration
    writeTo(buffer: ArrayBufferLike, byteOffset?: number, byteOrder?: Endianness): void;
    Parameters
    buffer
    ArrayBufferLike

    byteOffset
    number

    byteOrder
    Endianness

    Returns
    void

    Generated by DocFX