parser-de-notas-de-corretagem 0.4.4 → 0.5.1

package/notes-parser.d.ts

@@ -1,3 +1,5 @@
+import { AssetCrawler, AssetVerbosity } from "./asset-crawler";
+import { CashDividendShortVersion, StockDividendShortVersion } from './types/corporative-events';
 /** Deal made in a `NegotiationNote` type */
 export interface Deal {
     /** Deal type */
@@ -63,17 +65,22 @@ export declare class UnknownAsset extends Error {
 }
 /** Brokerage notes parser */
 export declare class NoteParser {
-    /** Path to the JSON data file */
-    private stockParser;
+    /** Info about the assets */
+    assetCrawler: AssetCrawler;
     /** The date format used. Default is `dd/MM/yyyy` */
     private dateFormat;
+    /** Set the verbosity level. Actually it's the same as the crawler */
+    private _verbosity;
+    /** Set the verbosity level */
+    set verbosity(v: AssetVerbosity);
+    get verbosity(): AssetVerbosity;
     /**
      * Instantiate a new `NoteParser`
      * @param autoUpdateLookUpList whether the application should auto-update
      * the list of assets for new changes every week. Default is `false`. Require internet connection.
      * Updating this package to the latest version also gets the latest infos
      */
-    constructor(autoUpdateLookUpList?: boolean);
+    constructor(autoUpdateLookUpList?: boolean, verbosity?: AssetVerbosity);
     /**
      * Set the date format
      * @param format a `DateFormat`
@@ -93,6 +100,13 @@ export declare class NoteParser {
      * @param cnpj stock CNPJ
      */
     defineStock(code: string, name: string, cnpj?: string, isFII?: boolean): void;
+    /**
+     * Get the stock dividends and the cash dividends of a given asset, if any
+     * @param code the asset code (letter only)
+     * @returns and `Array` where the first position is the list of stock dividends
+     * and the second position is a list of the cash dividends
+     */
+    getDividends(code: string): [StockDividendShortVersion[], CashDividendShortVersion[]];
     /**
      * Convert a date according to `dateFormat`
      * @param date the date to be formatted