pip-services4-persistence-node/src/write/IWriter.ts

Persistence Components for Pip.Services in Node.js / ES2017

/** @module core */
import { IContext } from 'pip-services4-components-node';

/**
 * Interface for data processing components that can create, update and delete data items.
 */
export interface IWriter<T, K> {
    /**
     * Creates a data item.
     * 
     * @param context    (optional) transaction id to trace execution through call chain.
     * @param item              an item to be created.
     * @return                  the created data item.
     */
    create(context: IContext, item: T): Promise<T>;

    /**
     * Updates a data item.
     * 
     * @param context    (optional) transaction id to trace execution through call chain.
     * @param item              an item to be updated.
     * @returns                 the updated data item.
     */
    update(context: IContext, item: T): Promise<T>;

    /**
     * Deleted a data item by it's unique id.
     * 
     * @param context    (optional) transaction id to trace execution through call chain.
     * @param id                an id of the item to be deleted
     * @returns                 the deleted data item.
     */
    deleteById(context: IContext, id: K): Promise<T>;
}