@fjell/lib/dist/primary/Operations.d.ts

Server-side Library for Fjell

import { Operations as AbstractOperations } from "../Operations";
import { Item, ItemQuery, PriKey } from "@fjell/core";
import { Registry } from "../Registry";
import { Coordinate } from "@fjell/registry";
import { Options } from "./Options";
export interface Operations<V extends Item<S>, S extends string> extends AbstractOperations<V, S> {
    all(itemQuery: ItemQuery): Promise<V[]>;
    one(itemQuery: ItemQuery): Promise<V | null>;
    create(item: Partial<Item<S>>, options?: {
        key: PriKey<S>;
    }): Promise<V>;
    update(key: PriKey<S>, item: Partial<Item<S>>): Promise<V>;
    /**
     * The key supplied to upsert will be used to retrieve the item, or to create a new item.  This method will
     * attempt to retrieve the item by the supplied key, and if the item is not found it will create a new item
     * using the properties supplied in the item parameter.
     * @param key - The key to use to retrieve the item, or to create a new item.
     * @param item - The properties to use to create a new item.
     * @param options - The options to use to create a new item.
     */
    upsert(key: PriKey<S>, item: Partial<Item<S>>): Promise<V>;
    get(key: PriKey<S>): Promise<V>;
    remove(key: PriKey<S>): Promise<V>;
    find(finder: string, finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<V[]>;
    findOne(finder: string, finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<V>;
    action(key: PriKey<S>, actionKey: string, actionParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<V>;
    facet(key: PriKey<S>, facetKey: string, facetParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<any>;
    allAction(allActionKey: string, allActionParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<V[]>;
    allFacet(allFacetKey: string, allFacetParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<any>;
}
export declare const wrapOperations: <V extends Item<S>, S extends string>(toWrap: Operations<V, S>, options: Options<V, S>, coordinate: Coordinate<S>, registry: Registry) => Operations<V, S>;