@fjell/lib/dist/Library.d.ts

Server-side Library for Fjell

import { Coordinate, Item } from "@fjell/types";
import { Instance as BaseInstance, Registry } from "@fjell/registry";
import { Operations } from "./Operations";
import { Options } from "./Options";
/**
 * The Library interface represents a data model library that extends the base Instance
 * from @fjell/registry and adds operations for interacting with the data model.
 *
 * The interface extends the base Instance (which provides coordinate and registry) with:
 * - operations: Provides methods for interacting with the data model (get, find, all, etc.)
 *
 * @template V - The type of the data model item, extending Item
 * @template S - The string literal type representing the model's key type
 * @template L1-L5 - Optional string literal types for location hierarchy levels
 */
export interface Library<V extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> extends BaseInstance<S, L1, L2, L3, L4, L5> {
    /** The operations object that provides methods for interacting with the data model */
    operations: Operations<V, S, L1, L2, L3, L4, L5>;
    /** The options object that provides hooks, validators, finders, actions, and facets */
    options: Options<V, S, L1, L2, L3, L4, L5>;
}
export declare const createLibrary: <V extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(registry: Registry, coordinate: Coordinate<S, L1, L2, L3, L4, L5>, operations: Operations<V, S, L1, L2, L3, L4, L5>, options?: Options<V, S, L1, L2, L3, L4, L5>) => Library<V, S, L1, L2, L3, L4, L5>;
export declare const isLibrary: (library: any) => library is Library<any, any, any, any, any, any, any>;