pinia-orm/dist/helpers.d.ts

The Pinia plugin to enable Object-Relational Mapping access to the Pinia Store.

import { M as Model, b as Collection } from './shared/pinia-orm.Bzthh6rU.js';
import 'pinia';
import 'vue-demi';
import '@pinia-orm/normalizr';
import '@/composables';

type SortFlags = 'SORT_REGULAR' | 'SORT_FLAG_CASE';

type sorting<T> = ((record: T) => any) | string | [string, 'asc' | 'desc'][];
/**
 * Creates an array of elements, sorted in specified order by the results
 * of running each element in a collection thru each iteratee.
 */
declare function useSortBy<T extends Record<string, any>>(collection: T[], sort: sorting<T>, flags?: SortFlags): T[];

interface UseCollect<M extends Model = Model> {
    sum: (field: string) => number;
    min: (field: string) => number;
    max: (field: string) => number;
    pluck: (field: string) => any[];
    groupBy: (fields: string[] | string) => Record<string, Collection<M>>;
    sortBy: (sort: sorting<M>, flags?: SortFlags) => M[];
    keys: () => string[];
}
/**
 * Return all possible helper functions for the collection
 */
declare function useCollect<M extends Model = Model>(models: Collection<M>): UseCollect<M>;

/**
 * Get the sum value of the specified filed.
 */
declare function useSum(models: Collection<any>, field: string): number;

/**
 * The useGroupBy method groups the collection's items by a given key.
 */
declare function useGroupBy<T extends Record<string, any>>(models: T[], fields: string[] | string): Record<string, T[]>;

/**
 * The keys method returns all of the collection's primary keys
 */
declare function useKeys(models: Collection<any>): string[];

/**
 * Get the min value of the specified filed.
 */
declare function useMin(models: Collection, field: string): number;

/**
 * Get the max value of the specified filed.
 */
declare function useMax(models: Collection, field: string): number;

/**
 * The pluck method retrieves all of the values for a given key.
 */
declare function usePluck(models: Collection, field: string): any[];

export { type UseCollect, type sorting, useCollect, useGroupBy, useKeys, useMax, useMin, usePluck, useSortBy, useSum };