yahoo-finance2/script/src/other/quoteCombine.d.ts

JS API for Yahoo Finance

/**
 * Utility function will debounce multiple calls and combine them into a
 * single {@linkcode [modules/quote] quote} call, i.e. you'll call `quoteCombine()` many times, and
 * 50ms (default) after the last call, `quote()` will be called once so that only a single
 * HTTP request is sent to collect the data for all symbols.
 *
 * @example
 * ```ts
 * import YahooFinance from 'yahoo-finance2';
 * const yahooFinance = new YahooFinance();
 *
 * // Only a single HTTP request will be made for all of these.
 * databaseResults.forEach(async (row) => {
 *   const result = await yahooFinance.quoteCombine(row.symbol);
 *   // do something
 * });
 *
 * // Consider asking only for what you need to save on bandwidth and latency
 * const fields = [ "regularMarketPrice", "regularMarketTime" ];
 * const result = await yahooFinance.quoteCombine("TSLA", { fields });
 * ```
 *
 * ### Notes:
 * - Each `quoteCombine()` call receives the result for only the symbol it asked for.
 *
 * - Query options (i.e. `fields`, above) and the shape of the return result are identical to that of quote().
 *
 * - If you call `quoteCombine()` multiple times with different {@linkcode QuoteOptions}, `quote()` will be called separately for each unique set of queryOptions and its associated set of symbols.
 *
 * - It's fine if your code calls `quoteCombine()` many times for the same symbol. The symbol will be queried only once, and returned many times.
 *
 * - You can override the defaults with `const yahooFinance = new YahooFinance({
 *     quoteCombine: QuoteCombineOptions
 *   })`, see {@linkcode QuoteCombineOptions} for more details.
 *
 * @module quoteCombine
 */
import type { ModuleOptionsWithValidateFalse, ModuleOptionsWithValidateTrue, ModuleThis } from "../lib/moduleCommon.js";
import type { Quote, QuoteOptions } from "../modules/quote.js";
/**
 * Pass as `new YahooFinance({ quoteCombine: options })` to override the defaults.
 *
 * @example
 * ```ts
 * const yahooFinance = new YahooFinance({
 *   quoteCombine: {
 *     maxSymbolsPerRequest: 50,
 *     debounceTime: 100,
 *   },
 * });
 * ```
 */
export interface QuoteCombineOptions {
    /** The maximum number of symbols to include in a single request, default: 100 */
    maxSymbolsPerRequest?: number;
    /** The amount of time (in milliseconds) to debounce requests, default: 50 */
    debounceTime?: number;
}
/** quoteCombine defaults.  Override with `new Yahoo Finance({ quoteCombine: options })`. */
export declare const defaultOptions: QuoteCombineOptions;
/**
 * Debounce multiple calls into a single {@linkcode [modules/quote] quote()} network request.
 *
 * **See the {@link [other/quoteCombine] quoteCombine module} docs for examples and more.**
 * @see {@link [other/quoteCombine] quoteCombine module} docs for examples and more.
 */
export default function quoteCombine(this: ModuleThis, query: string, queryOptionsOverrides?: QuoteOptions, moduleOptions?: ModuleOptionsWithValidateTrue): Promise<Quote>;
/**
 * Debounce multiple calls into a single {@linkcode [modules/quote] quote()} network request.
 *
 * **See the {@link [other/quoteCombine] quoteCombine module} docs for examples and more.**
 * @see {@link [other/quoteCombine] quoteCombine module} docs for examples and more.
 */
export default function quoteCombine(this: ModuleThis, query: string, queryOptionsOverrides?: QuoteOptions, moduleOptions?: ModuleOptionsWithValidateFalse): Promise<unknown>;
//# sourceMappingURL=quoteCombine.d.ts.map