Typescript Conversion

.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 node_modules
 *.class
+target/

README.md

@@ -22,6 +22,13 @@ const df = new DecimalFormat('#.000');
 const result = df.format(1.234);
 ```
 
+```ts
+import {DecimalFormat} from "@deloitte-digital-au/decimalformat";
+const locale = { decimalSeparator: '.', groupingSeparator: ',' }
+const df = new DecimalFormat('#.000');
+const result = df.format(1.234, locale);
+```
+
 #### Using the parser
 
 If you only require the internals of a pattern, you can parse an expression with the `DecimalFormat` class, with:
@@ -31,6 +38,12 @@ const { parser } = require('DecimalFormat');
 const result = parser.parse('#.000');
 ```
 
+```ts
+import { parser, GrammarParsed } from "@deloitte-digital-au/decimalformat";
+const result : GrammarParsed = parser.parse('#.000');
+```
+
+
 #### Grammar
 
 The grammar is contained in `src/decimalformat.pegjs`
@@ -192,6 +205,20 @@ Tests can be run with:
 npm run test
 ```
 
+## Build & NPM package
+Since the typescript implementation, we have got a build step which provides the package into the "target" folder. Currently, a source map and the typescript types files are generated as well.
+
+```bash
+npm run build
+(cd target && npm publish)
+```
+
+If you want to use your local package version without publishing, you will need to link the target folder instead of the source.
+
+```bash
+(cd target && sudo npm link)
+```
+
 ## License
 
 **BSD 3-Clause License**

dist/parser.d.ts

@@ -0,0 +1,20 @@
+declare module "@deloitte-digital-au/decimalformat/dist/parser" {
+    export function parse(input: string): GrammarParsed;
+
+    export interface GrammarParsed {
+        positive : Pattern,
+        negative : Pattern,
+    }
+
+    export interface Pattern {
+        prefix : string, 
+        suffix : string, 
+        decimalSeparatorAlwaysShown : boolean,
+        mantissa : boolean,
+        groupingSize : number,
+        minimumFractionDigits : number,
+        maximumFractionDigits : number,
+        minimumIntegerDigits : number,
+        maximumIntegerDigits : number,
+    }
+}