@magnetarjs/types/dist/types/modifyPayload.d.ts

Magnetar shared types

import { PartialDeep } from './utils/PartialDeep.js';
/**
 * This function will be executed everytime BEFORE the related action is triggered. The function defined will receive the payload of the action. You can then modify and return this payload.
 */
export type ModifyWritePayload<DocDataType extends {
    [key: string]: any;
} = {
    [key: string]: any;
}> = (payload: PartialDeep<DocDataType>, docId?: string | undefined) => PartialDeep<DocDataType>;
/**
 * This function will be executed everytime BEFORE the related action is triggered. The function defined will receive the payload of the action. You can then modify and return this payload.
 */
export type ModifyDeletePropPayload = (payload: string | string[]) => string | string[];
/**
 * This function will be executed everytime BEFORE the related action is triggered. The function defined will receive the payload of the action. You can then modify and return this payload.
 */
export type ModifyReadPayload = (payload: {
    [key: string]: any;
} | undefined, docId?: string | undefined) => {
    [key: string]: any;
} | undefined;
/**
 * These functions will be executed everytime BEFORE the related action is triggered. The function defined will receive the payload of the action. You can then modify and return this payload.
 */
export type ModifyPayloadFnMap<DocDataType extends {
    [key: string]: any;
} = {
    [key: string]: any;
}> = {
    insert?: ModifyWritePayload<DocDataType>;
    merge?: ModifyWritePayload<DocDataType>;
    assign?: ModifyWritePayload<DocDataType>;
    replace?: ModifyWritePayload<DocDataType>;
    write?: ModifyWritePayload<DocDataType>;
    deleteProp?: ModifyDeletePropPayload;
    read?: ModifyReadPayload;
    stream?: ModifyReadPayload;
    fetch?: ModifyReadPayload;
};
/**
 * These functions will be executed everytime BEFORE the related action is triggered. The function defined will receive the payload of the action. You can then modify and return this payload.
 */
export type ModifyPayloadFnsMap = {
    insert: ModifyWritePayload[];
    merge: ModifyWritePayload[];
    assign: ModifyWritePayload[];
    replace: ModifyWritePayload[];
    write: ModifyWritePayload[];
    deleteProp: ModifyDeletePropPayload[];
    delete: never[];
    read: ModifyReadPayload[];
    stream: ModifyReadPayload[];
    fetch: ModifyReadPayload[];
};