lit-securities-utility/dist/store/index.d.ts

A utility package for securities applications

import { IStore } from '../TYPES/Store';
/**
 * Description placeholder
 *
 * @type {IStore}
 */
declare let store: IStore;
/**
 * Adds data to the store. It iterates over the keys of the input store and updates the store accordingly.
 * Each key corresponds to a specific type of data, and the function calls appropriate methods to update the store.
 *
 * @param {IStore} inputStore The store object containing the data to be added.
 */
export declare function addStore(inputStore: IStore): void;
/**
 * Adds master data to the store.
 *
 * @param {IStore["MASTER_DATA"]} data The master data to be added to the store.
 */
export declare function addMasterData(data: IStore['MASTER_DATA']): void;
/**
 * Adds script ID index data to the store.
 *
 * @param {IStore["SCRIPT_ID_INDEX"]} data The script ID index data to be added to the store.
 */
export declare function addScripIdIndexes(data: IStore['SCRIPT_ID_INDEX']): void;
/**
 * Adds derivatives index data to the store.
 *
 * @param {IStore["DERIVATIVES_INDEX"]} data The derivatives index data to be added to the store.
 */
export declare function addDerivativeIndexes(data: IStore['DERIVATIVES_INDEX']): void;
/**
 * Adds ISIN code index data to the store.
 *
 * @param {IStore["ISIN_CODE_INDEX"]} data The ISIN code index data to be added to the store.
 */
export declare function addIsinCodeIndexex(data: IStore['ISIN_CODE_INDEX']): void;
/**
 * Adds search string index data to the store.
 *
 * @param {IStore["SEARCH_STRING_INDEX"]} data The search string index data to be added to the store.
 */
export declare function addSearchStringIndexes(data: IStore['SEARCH_STRING_INDEX']): void;
/**
 * Retrieves the master data from the store.
 *
 * @returns {TMasterData} The master data stored in the store.
 */
export declare function getMasterData(): import('../TYPES/Store').TMasterData;
/**
 * Retrieves the script ID index data from the store.
 *
 * @returns {TScriptIdIndex} The script ID index data stored in the store.
 */
export declare function getScripIndex(): import('../TYPES/Store').TScriptIdIndex;
/**
 * Retrieves the derivatives index data from the store.
 *
 * @returns {TDerivativesIndex} The derivatives index data stored in the store.
 */
export declare function getDerivativeIndex(): import('../TYPES/Store').TDerivativesIndex;
/**
 * Retrieves the search string index data from the store.
 *
 * @returns {TSearchStringIndex} The search string index data stored in the store.
 */
export declare function getSearchIndex(): import('../TYPES/Store').TSearchStringIndex;
/**
 * Retrieves the ISIN code index data from the store.
 *
 * @returns {IIsinCodeIndex} The ISIN code index data stored in the store.
 */
export declare function getIsinIndex(): import('../TYPES/Store').TIsinCodeIndex;
/**
 * Sets the security master initialization status in the store to true.
 *
 */
export declare function setSecurityMasterInitializationStatus(): void;
/**
 * Retrieves the security master initialization status from the store.
 *
 * @returns {boolean} The security master initialization status.
 */
export declare function getSecurityMasterInitializationStatus(): boolean;
export default store;