chore: add types declaration (#45)

index.d.ts

@@ -0,0 +1,48 @@
+declare type HelperFunction = (params: {
+    args: any[];
+    opt: Record<string, any>;
+    context: Record<string, any>;
+    fn: (context?: Record<string, any>, vars?: Record<string, any>, output?: string[]) => string;
+}) => string;
+
+declare interface Helpers {
+    [key: string]: HelperFunction;
+}
+
+declare interface Partials {
+    [key: string]: string;
+}
+
+declare interface Functions {
+    [key: string]: (params: {
+        args: any[];
+        opt: Record<string, any>;
+        context: Record<string, any>;
+    }) => string | void;
+}
+
+declare interface MikelOptions {
+    helpers?: Helpers;
+    partials?: Partials;
+    functions?: Functions;
+}
+
+declare interface MikelTemplate {
+    (data?: any): string;
+    addHelper(name: string, fn: HelperFunction): void;
+    removeHelper(name: string): void;
+    addFunction(name: string, fn: (params: any) => string | void): void;
+    removeFunction(name: string): void;
+    addPartial(name: string, partial: string): void;
+    removePartial(name: string): void;
+}
+
+declare const mikel: {
+    (template: string, data?: any, options?: Partial<MikelOptions>): string;
+    create(template: string, options?: Partial<MikelOptions>): MikelTemplate;
+    escape(str: string): string;
+    get(context: any, path: string): any;
+    parse(value: string, context?: any, vars?: any): any;
+};
+
+export default mikel;

package.json

@@ -12,6 +12,7 @@
     "bugs": "https://github.com/jmjuanes/mikel/issues",
     "main": "index.js",
     "module": "index.js",
+    "types": "index.d.ts",
     "exports": {
         ".": "./index.js",
         "./package.json": "./package.json"
@@ -26,6 +27,7 @@
     "files": [
         "README.md",
         "LICENSE",
-        "index.js"
+        "index.js",
+        "index.d.ts"
     ]
 }