Documented the exchange interface.

This commit is contained in:
2023-10-06 16:53:03 -04:00
parent bf3c140c46
commit 8635fea937
3 changed files with 125 additions and 4 deletions

View File

@@ -1,9 +1,23 @@
import { PortfolioProvider } from "./interface/portfolio";
import { QuoteProvider } from "./interface/quote";
/**
* Represents an exchange, which provides access to a portfolio provider and a quote provider.
*/
export interface Exchange {
/**
* The portfolio provider for the exchange.
*/
readonly portfolioProvider: PortfolioProvider;
/**
* The quote provider for the exchange.
*/
readonly quoteProvider: QuoteProvider;
/**
* The name of the exchange.
*/
readonly name: string;
}
}