@am92/securities-utility/dist/index.d.ts

A utility package for securities applications

import { IConfig } from './TYPES/Config';
export { getScripByScripId, getDerivativeScripsByScripId, getScripsByIsinCode, getScripsByScripIds } from './secMaster';
export * from './Search/SearchManager';
/**
 * Initializes the system by setting up the security master download and preparing the required modules.
 *
 * @param {string} secMasterURL - The URL for the security master, used for downloading data and setting up indexes.
 * @param {IConfig} [config=DEFAULT_VALUES] - Configuration object to customize the initialization behavior.
 *   - `requireSearchModule` {boolean} - Specifies whether the search module is required (default: `false`).
 *   - `requireSocketModule` {boolean} - Specifies whether the socket module is required (default: `false`).
 *
 * @throws A warning if `secMasterURL` is invalid or not provided.
 */
export declare function initialize(secMasterURL: string, config?: IConfig): void;
/**
 * Checks if the security master has been successfully loaded and initialized.
 *
 * @returns {boolean} - `true` if the security master is initialized, otherwise `false`.
 */
export declare function isSecurityMasterLoaded(): boolean;