parser-de-notas-de-corretagem 0.4.3 → 0.5.0

package/README.md

@@ -133,6 +133,13 @@ async function main() {
 main();
 ```
 
+### Browser
+Since only `Uint8Array` is accepted, use the following code to convert a string using the browser
+```JavaScript
+if (typeof fileContent === 'string') fileContent = Uint8Array.from(fileContent, x => x.charCodeAt(0));
+assetsParser.parseNote(filePath, fileContent, filePasswords);
+```
+
 ### Add a custom stock
 ```Typescript
 const assets = new NoteParser();

package/notes-parser.d.ts

@@ -1,3 +1,4 @@
+import { CashDividendShortVersion, StockDividendShortVersion } from './types/corporative-events';
 /** Deal made in a `NegotiationNote` type */
 export interface Deal {
     /** Deal type */
@@ -93,6 +94,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