immutable-json-patch/lib/types/types.d.ts

Immutable JSON patch with support for reverting operations

export type JSONPointer = string;
export type JSONPath = string[];
export interface JSONPatchAdd {
    op: 'add';
    path: JSONPointer;
    value: unknown;
}
export interface JSONPatchRemove {
    op: 'remove';
    path: JSONPointer;
}
export interface JSONPatchReplace {
    op: 'replace';
    path: JSONPointer;
    value: unknown;
}
export interface JSONPatchCopy {
    op: 'copy';
    path: JSONPointer;
    from: JSONPointer;
}
export interface JSONPatchMove {
    op: 'move';
    path: JSONPointer;
    from: JSONPointer;
}
export interface JSONPatchTest {
    op: 'test';
    path: JSONPointer;
    value: unknown;
}
export type JSONPatchOperation = JSONPatchAdd | JSONPatchRemove | JSONPatchReplace | JSONPatchCopy | JSONPatchMove | JSONPatchTest;
export type JSONPatchDocument = JSONPatchOperation[];
export type JSONPatchOptions<T = unknown, U = unknown, V = unknown, W = unknown, X = unknown> = {
    before?: (document: T, operation: JSONPatchOperation) => {
        document?: U;
        operation?: JSONPatchOperation;
    };
    after?: (document: V, operation: JSONPatchOperation, previousDocument: W) => X;
};
export type RevertJSONPatchOptions<T = unknown, U = unknown> = {
    before?: (document: T, operation: JSONPatchOperation, revertOperations: JSONPatchOperation[]) => {
        document?: U;
        revertOperations?: JSONPatchOperation[];
    };
};
/**
 * @deprecated use generics or `unknown` instead
 */
export type JSONPrimitive = string | number | boolean | null;
/**
 * @deprecated use generics or `unknown` instead
 */
export type JSONValue = {
    [key: string]: JSONValue;
} | JSONValue[] | JSONPrimitive;
/**
 * @deprecated use generics or `unknown` instead
 */
export type JSONObject = {
    [key: string]: JSONValue;
};
/**
 * @deprecated use generics or `unknown` instead
 */
export type JSONArray = JSONValue[];
//# sourceMappingURL=types.d.ts.map