ixfx
    Preparing search index...

    Function arrayObject

    • arrayObject<V>(
          initialValue?: readonly V[],
          options?: Partial<ArrayObjectOptions<V>>,
      ): Reactive<V[]> & { set(value: V[]): void } & {
          deleteAt(index: number): void;
          deleteWhere(filter: (value: V) => boolean): number;
          insertAt(index: number, value: V): void;
          onArray(
              handler: (changes: Passed<ChangeRecord<number>[]>) => void,
          ): () => void;
          push(value: V): void;
          setAt(index: number, value: V): void;
      } & Reactive<readonly V[]> & { last(): readonly V[] }

      Wraps an array object.

      It returns an reactive along with some array-ish functions to manipulating it.

      Type Parameters

      • V

      Parameters

      Returns Reactive<V[]> & { set(value: V[]): void } & {
          deleteAt(index: number): void;
          deleteWhere(filter: (value: V) => boolean): number;
          insertAt(index: number, value: V): void;
          onArray(
              handler: (changes: Passed<ChangeRecord<number>[]>) => void,
          ): () => void;
          push(value: V): void;
          setAt(index: number, value: V): void;
      } & Reactive<readonly V[]> & { last(): readonly V[] }

      • set:function
        • set(value: V[]): void

          Sets a value

          Parameters

          • value: V[]

            Value to write

          Returns void

      • deleteAt:function
        • deleteAt(index: number): void

          Parameters

          • index: number

          Returns void

      • deleteWhere:function
        • deleteWhere(filter: (value: V) => boolean): number

          Parameters

          • filter: (value: V) => boolean

          Returns number

      • insertAt:function
        • insertAt(index: number, value: V): void

          Parameters

          • index: number
          • value: V

          Returns void

      • onArray:function
      • push:function
        • push(value: V): void

          Parameters

          • value: V

          Returns void

      • setAt:function
        • setAt(index: number, value: V): void

          Parameters

          • index: number
          • value: V

          Returns void

      • last:function
        • last(): readonly V[]

          Returns readonly V[]

    Settings

    Member Visibility