yahoo-finance2
Version:
JS API for Yahoo Finance
26 lines (25 loc) • 957 B
JavaScript
/**
* @module YahooFinance
*/
import createYahooFinance from "./createYahooFinance.js";
import * as modules from "./modules/index.js";
import * as other from "./other/index.js";
const allModules = { ...modules, ...other };
const createOpts = { modules: allModules };
/**
* The full Yahoo Finance API client with all modules: `quote()`, `search()`, etc.
*
* @example
* ```ts
* import YahooFinance from "yahoo-finance2";
*
* const yahooFinance = new YahooFinance();
* console.log(await yahooFinance.quote("AAPL"));
* ```
*
* @see {@linkcode [createYahooFinance].YahooFinance YahooFinance} for instantiation options.
* @see The full list of {@link [modules] main modules} and {@link [other] other modules}.
* @see {@linkcode [createYahooFinance].createYahooFinance createYahooFinance} for creating an API client with custom modules (advanced use-cases only).
*/
const YahooFinance = createYahooFinance(createOpts);
export default YahooFinance;