mingo/types/updater.d.ts

MongoDB query language for in-memory objects

import { UpdateOptions } from "./core";
import * as UPDATE_OPERATORS from "./operators/update";
import { AnyObject } from "./types";
/** Define maps to enforce a single key from a union. */
type OneKey<K extends keyof any, V, KK extends keyof any = K> = {
    [P in K]: {
        [Q in P]: V;
    } & {
        [Q in Exclude<KK, P>]?: never;
    } extends infer O ? {
        [Q in keyof O]: O[Q];
    } : never;
}[K];
export type UpdateExpression = OneKey<keyof typeof UPDATE_OPERATORS, AnyObject>;
/** A function to process an update expression and modify the object. */
export type Updater = (obj: AnyObject, expr: UpdateExpression, arrayFilters?: AnyObject[], condition?: AnyObject, options?: UpdateOptions) => string[];
/**
 * Creates a new updater function with default options.
 * @param defaultOptions The default options. Defaults to no cloning with strict mode off for queries.
 * @returns {Updater}
 */
export declare function createUpdater(defaultOptions?: UpdateOptions): Updater;
/**
 * Updates the given object with the expression.
 *
 * @param obj The object to update.
 * @param expr The update expressions.
 * @param arrayFilters Filters to apply to nested items.
 * @param conditions Conditions to validate before performing update.
 * @param options Update options to override defaults.
 * @returns {string[]} A list of modified field paths in the object.
 */
export declare const update: Updater;
/**
 * @deprecated Use {@link update}.
 */
export declare const updateObject: Updater;
export {};