@state-sync/redux-path-reducer/dist/ISyncArea.d.ts

state-sync client only json path reducer

/**
 * Store area synchronized with server side. Sync rules are defined by server side.
 *
 */
export interface ISyncArea {
    /**
     * Replace value in area state
     * @param {string} path path to value
     * @param value new value
     */
    actionReplace(path: string, value: any): void;
    /**
     * Toggle value in area state
     * @param {string} path
     */
    actionToggle(path: string): void;
    /**
     * Remove value by path
     * @param {string} path
     * @param {(item:any) => boolean)} condition - optional remove condition
     */
    actionRemove(path: string, condition?: (item: any) => boolean): void;
    /**
     * Insert new item into array and sort
     * @param {string} path
     * @param item
     * @param {string} keyField
     */
    actionArrayInsertByKey(path: string, item: any, keyField: string): void;
    /**
     * Replace array item by key
     * @param {string} path
     * @param item
     * @param {string} keyField
     */
    actionArrayReplaceByKey(path: string, item: any, keyField: string): void;
    /**
     * Remove array element by key field
     * @param {string} path
     * @param {string} keyField
     * @param value
     */
    actionArrayRemoveByKey(path: string, keyField: string, value: any): void;
    /**
     * Remove array element by index
     * @param {string} path
     * @param {number} index
     */
    actionArrayRemoveByIndex(path: string, index: number): void;
    /**
     * Select state part specified by path, modify by given reducer and push changes back to state.
     * As usual changes and synchronized back to server (if configured by server)
     * @param {string} path
     * @param {<T>(state: T) => T} reducer
     */
    actionReduce<T>(path: string, reducer: (state: T) => T): void;
    /**
     * Subscribe to synchronization, repeat call of this method increment refs counter.
     */
    subscribe(): Promise<number>;
    /**
     * Unsubscribe area from synchronization. Decrement refs counter.
     * Actual subscription occurs then refs counter became zero.
     */
    unsubscribe(): void;
    /**
     * Send signal to server with parameters,
     * once completed and state syncronized with server, promise wil be resolved.
     * @param {string} command
     * @param parameters
     * @returns {Promise}
     */
    signal(command: string, parameters?: any): Promise<number>;
    /**
     * Expose area model. Do not modify model in your code
     * @returns {any}
     */
    model(): any;
    /**
     * Select model by path
     * @param {string} path
     * @returns {any}
     */
    select(path: string): any;
    /**
     * Area fully initialized from server and ready to use in UI
     * @returns {boolean}
     */
    isReady(): boolean;
}