import { IIdName } from '../models/id-name.mjs';
import { IId, IName } from '../models/interfaces.mjs';
import { ArrayOrSingle } from '../models/types.mjs';
export declare function arrayGetIds<T extends Required<IId<Tid>>, Tid = T['id']>(arr?: Readonly<T>[], callback?: (item: T) => Tid): Tid[];
export declare function arrayGetIdNames<T extends IIdName<Tid, Tname>, Tid = T['id'], Tname = T['name']>(arr?: Readonly<T>[], callback?: (item: T) => IIdName<Tid, Tname>): IIdName<Tid, Tname>[];
export declare function arrayGetNames<T extends IName<Tname>, Tname = T['name']>(arr?: Readonly<T>[], callback?: (item: T) => Tname): Tname[];
/**
 * Return the object with the given id from the array.
 * @param arrItems The array to search for the ids.
 * @param id id to search for in the arrItems list.
 * @returns The object with the given name. If not found, undefined is returned.
 */
export declare function arrayFindById<T extends IId<Tid>, Tid = T['id']>(arrItems?: T[], id?: Tid): T | undefined;
/**
 * Return the object with the given id from the array.
 * @param arrItems The array to search for the ids.
 * @param id id to search for in the arrItems list.
 * @returns The name of the found item. If not found, undefined is returned.
 */
export declare function arrayFindNameById<T extends IIdName<Tid, Tname>, Tid = T['id'], Tname = T['name']>(arrItems?: T[], id?: Tid): Tname | undefined;
/**
 * Return the objects that contain the given ids.
 * @param arrItems The array to search for the ids.
 * @param ids The array of ids to find in arrItems.
 * @returns The object with the given name. If not found, an empty Array is returned.
 */
export declare function arrayFindByIds<T extends Required<IId<Tid>>, Tid = T['id']>(arrItems?: T[], ids?: Tid[]): T[];
/**
 * Return the objects that do NOT match any of the given ids.
 * @param arrItems The array to search for the ids.
 * @param ids The array of ids to NOT find in arrItems.
 * @returns The object with the given name. If not found, and exception is thrown.
 */
export declare function arrayFindByNotIds<T extends Required<IId<Tid>>, Tid = T['id']>(arrItems?: T[], ids?: Tid[]): T[];
export declare function arrayMustFind<T extends IId<Tid>, Tid = T['id']>(arrItems: T[] | undefined, id: Tid, functionSourceName?: string): T;
/**
 * Return the object with the given name from the array.
 * @param arrItems The array of items to search for the name. Null checks are taken into account.
 * @param name Name to search for in the IName
 * @returns The object with the given name. If not found, and exception is thrown.
 */
export declare function arrayFindByName<T extends IName<Tname>, Tname = T['name']>(arrItems?: T[], name?: Tname): T | undefined;
export declare function arrayFilter<T>(arrItems: T[] | undefined, filterFunc: (item: T) => boolean): T[];
export declare function arrayFind<T>(arrItems: T[] | undefined, findFunc: (item: T) => boolean): T | undefined;
export declare function arrayMustFindFunc<T>(arrItems: T[], findFunc: (item: T) => boolean, functionSourceName?: string, exceptionSuffix?: () => string): NonNullable<T>;
export declare function arrayMustFindByName<T extends IName<Tname>, Tname = T['name']>(arrItems: T[], name: Tname, functionSourceName?: string): NonNullable<T>;
export declare function arrayOfIds<T extends IId<Tid>, Tid = T['id']>(arr?: Readonly<T>[]): NonNullable<T["id"]>[];
export declare function arrayOfNames<T extends IName<Tname>, Tname = T['name']>(arr?: Readonly<T>[]): Tname[];
export declare function arrayElementNonEmpty<T>(arr?: T[], index?: number, functionSourceName?: string, customMessage?: string): NonNullable<T>;
/**
 * Gets the first item from an array, or a default value if the array is empty. Undefined is returned if no default value provided.
 * Good for quick tests of objects to see if it is an array, and getting the first value.
 * @param tArray The array to get the first value from, if it is an array.
 * @param defaultIfNone An optional default value if the array is empty.
 * @returns The first item in the array, or undefined or defaultIfNone if the array has no values.
 */
export declare function arrayFirst<T>(tArray?: T[], defaultIfNone?: T): T | undefined;
export declare function arrayFirstNonEmpty<T>(arr?: T[], functionSourceName?: string, customMessage?: string): NonNullable<T>;
/**
 * Gets the last item from an array, or a default value if the array is empty. Null is returned if no default value provided.
 * Good for quick tests of objects to see if it is an array, and getting the first value.
 * @param tArray The array to get the last value from, if it is an array.
 * @param defaultIfNone An optional default value if the array is empty.
 * @returns The last item in the array, or null or defaultIfNone if the array has no values.
 */
export declare function arrayLast<T>(tArray?: T[], defaultIfNone?: T): T | undefined;
export declare function arrayLastNonEmpty<T>(arr?: T[], functionSourceName?: string, customMessage?: string): NonNullable<T>;
export declare function arrayForEachReturns<T>(arr: T[] | undefined, funcArrayResults: (item: T) => void): void;
export declare function ToSafeArray<T = unknown>(arrOrT?: Readonly<ArrayOrSingle<T>>): T[];
/**
 * Helper function to reduce an array of objects or arrays.
 * Takes care of handling undefined, objects and/or arrays and returns a guaranteed flattened array of type TreturnType.
 * Keep in mind, this is only for when you want to return an array of IId<T> type derived objects.
 * @param arr The array or single item to iterate over. ToSafeArray is called.
 * @param funcArrayResults Callback that returns undefined or an object or array of TreturnType.
 * @returns The reduced array of all objects and arrays returned funcArrayResults. Will be [] if all returns were undefined or the calling array is undefined.
 */
export declare function arrayReduceArrayReturns<T, TreturnType = T>(arr: Readonly<ArrayOrSingle<T>> | undefined, funcArrayResults: (item: T, index: number) => ArrayOrSingle<TreturnType> | undefined): TreturnType[];
export declare function arraySwapItemsById<T extends IId<Tid>, Tid = T['id']>(arrItems: T[], sourceId: Tid, destId: Tid): T[];
export declare function arraySwapItems<T>(arrItems: T[], sourceIndex: number, destIndex: number): T[];
//# sourceMappingURL=array-helper.d.mts.map