import { Atom, AtomActions, AtomOptions } from "./types.mjs";

//#region ../@mongez/atom/src/atom-collection.d.ts
type IndexOrCallback<Value> = number | ((value: Value, index: number, list: Value[]) => boolean);
interface AtomCollectionActions<Value> extends AtomActions<Value[]> {
  /**
   * Add items to the end of the array
   */
  push(this: Atom<Value[]>, ...items: Value[]): void;
  /**
   * Add items to the beginning of the array
   */
  unshift(this: Atom<Value[]>, ...items: Value[]): void;
  /**
   * Remove the last item from the array
   */
  pop(this: Atom<Value[]>): void;
  /**
   * Remove the first item from the array
   */
  shift(this: Atom<Value[]>): void;
  /**
   * Remove item from array either by index or callback
   */
  remove(this: Atom<Value[]>, indexOrCallback: IndexOrCallback<Value>): void;
  /**
   * Remove item from array by value
   */
  removeItem(this: Atom<Value[]>, item: Value): void;
  /**
   * Remove all occurrences of an item from the array
   */
  removeAll(this: Atom<Value[]>, item: Value): void;
  /**
   * Get item from array either by index or callback
   */
  get(this: Atom<Value[]>, indexOrCallback: IndexOrCallback<Value>): Value | undefined;
  /**
   * Find index of item in array by callback
   */
  index(this: Atom<Value[]>, callback: (item: Value, index: number, array: Value[]) => boolean): number;
  /**
   * Map array items
   * This will update the array with the new mapped array and trigger update
   */
  map(this: Atom<Value[]>, callback: (item: Value, index: number, array: Value[]) => Value): Value[];
  /**
   * Loop through array items
   */
  forEach(this: Atom<Value[]>, callback: (item: Value, index: number, array: Value[]) => void): void;
  /**
   * Replace item in array by index
   */
  replace(this: Atom<Value[]>, index: number, item: Value): void;
  /**
   * Get array length
   */
  length: number;
}
type CollectionOptions<Value> = Omit<AtomOptions<Value[], AtomCollectionActions<Value>>, 'default'> & {
  default?: Value[];
};
/**
 * Create an atom collection
 */
declare function atomCollection<Value = any>(options: CollectionOptions<Value>): Atom<Value[], AtomCollectionActions<Value>>;
//#endregion
export { AtomCollectionActions, CollectionOptions, IndexOrCallback, atomCollection };
//# sourceMappingURL=atom-collection.d.mts.map