10 declarations
indexed_collection_helpers.svelte.ts view source
<T extends IndexedItem, TResult extends Array<T> = T[]>(options: DerivedIndexOptions<T, TResult>): IndexDefinition<T, TResult, void> Create an incremental derived collection index.
optionsDerivedIndexOptions<T, TResult>IndexDefinition<T, TResult, void> indexed_collection_helpers.svelte.ts view source
<T extends IndexedItem, F extends (...args: Array<any>) => any>(options: DynamicIndexOptions<T, F>): IndexDefinition<T, F, Parameters<F>[0]> Create a dynamic index that computes results on-demand based on query parameters.
optionsDynamicIndexOptions<T, F>IndexDefinition<T, F, Parameters<F>[0]> indexed_collection_helpers.svelte.ts view source
<T extends IndexedItem, K>(options: MultiIndexOptions<T, K>): IndexDefinition<T, SvelteMap<K, T[]>, K> Create a multi-value index (one key maps to many items).
optionsMultiIndexOptions<T, K>IndexDefinition<T, SvelteMap<K, T[]>, K> indexed_collection_helpers.svelte.ts view source
<T extends IndexedItem, K>(options: SingleIndexOptions<T, K>): IndexDefinition<T, SvelteMap<K, T>, K> Create a single-value index (one key maps to one item).
optionsSingleIndexOptions<T, K>IndexDefinition<T, SvelteMap<K, T>, K> indexed_collection_helpers.svelte.ts view source
DerivedIndexOptions<T, TResult> Options for derived indexes.
TTResultArray<T>Array<T>IndexOptions<T, void>computeFunction that computes the derived collection from the full collection.
(collection: IndexedCollection<T>) => TResultsortOptional sort function for the derived array.
(a: T, b: T) => numberonaddOptional custom add handler.
(items: TResult, item: T, collection: IndexedCollection<T>) => TResultonremoveOptional custom remove handler.
(items: TResult, item: T, collection: IndexedCollection<T>) => TResultindexed_collection_helpers.svelte.ts view source
DynamicIndexOptions<T, F> Options for dynamic indexes.
TF(...args: Array<any>) => anyIndexOptions<T, Parameters<F>[0]>factoryFunction that creates a query function from the collection
(collection: IndexedCollection<T>) => FonaddOptional custom add handler
(fn: F, item: T, collection: IndexedCollection<T>) => FonremoveOptional custom remove handler
(fn: F, item: T, collection: IndexedCollection<T>) => Findexed_collection_helpers.svelte.ts view source
ZodObject<{ id: ZodDefault<$ZodBranded<ZodUUID, "Uuid">>; }, $strict> Interface for objects that can be stored in an indexed collection.
indexed_collection_helpers.svelte.ts view source
IndexOptions<T, TQuery> Common options interface for all index types.
TTQueryanykeyUnique key for this index.
stringmatchesOptional predicate to determine if an item is relevant to this index.
(item: T) => booleanquery_schemaSchema for query input validation and typing.
z.ZodType<TQuery>indexed_collection_helpers.svelte.ts view source
MultiIndexOptions<T, K> Options for multi-value indexes.
TKIndexOptions<T, K>extractorFunction that extracts the key(s) from an item.
(item: T) => K | Array<K> | undefinedsortOptional sort function for items in each bucket.
(a: T, b: T) => numberindexed_collection_helpers.svelte.ts view source
SingleIndexOptions<T, K> Options for single-value indexes.
TKIndexOptions<T, K>extractorFunction that extracts the key from an item
(item: T) => K