added form-data-json.d.ts for better typescript autocompletion support

brainfoolong · Apr 12, 2024 · da6a79c · da6a79c
1 parent 59bbdac
commit da6a79c
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+### 2.2.2 - 2024-04-12
+
+* added form-data-json.d.ts for better typescript autocompletion support (thx to @kurybr - https://github.com/brainfoolong/form-data-json/issues/36)
+
 ### 2.2.1 - 2023-08-13
 
 * fixed set checkbox checked with array values on implicit names https://github.com/brainfoolong/form-data-json/issues/35

diff --git a/dist/form-data-json.d.ts b/dist/form-data-json.d.ts
@@ -0,0 +1,38 @@
+declare module 'form-data-json-convert' {
+	interface OptionsToJson {
+	  includeDisabled?: boolean;
+	  includeButtonValues?: boolean;
+	  uncheckedValue?: any;
+	  inputFilter?: ((inputElement: HTMLInputElement) => boolean) | null;
+	  flatList?: boolean;
+	  skipEmpty?: boolean;
+	  filesCallback?: ((values: any) => void) | null;
+	  fileReaderFunction?: string;
+	  arrayify?: boolean;
+	}
+
+	interface OptionsFromJson {
+	  flatList?: boolean;
+	  clearOthers?: boolean;
+	  resetOthers?: boolean;
+	  triggerChangeEvent?: boolean;
+	}
+
+	function toJson(
+	  form: HTMLFormElement | string | JQuery,
+	  options?: OptionsToJson
+	): any;
+
+	function fromJson(
+	  form: HTMLFormElement | string | JQuery,
+	  values: any,
+	  options?: OptionsFromJson
+	): void;
+
+	function reset(form: HTMLFormElement | string | JQuery): void;
+
+	function clear(form: HTMLFormElement | string | JQuery): void;
+
+	const defaultOptionsToJson: OptionsToJson;
+	const defaultOptionsFromJson: OptionsFromJson;
+  }
diff --git a/dist/form-data-json.es6.js b/dist/form-data-json.es6.js
@@ -1,4 +1,4 @@
-// form-data-json-convert | version: 2.2.1 | url: https://github.com/brainfoolong/form-data-json
+// form-data-json-convert | version: 2.2.2 | url: https://github.com/brainfoolong/form-data-json
 /**
  * Form Data Json Converter
  * @link https://github.com/brainfoolong/form-data-json

diff --git a/dist/form-data-json.js b/dist/form-data-json.js
@@ -1,4 +1,4 @@
-// form-data-json-convert | version: 2.2.1 | url: https://github.com/brainfoolong/form-data-json
+// form-data-json-convert | version: 2.2.2 | url: https://github.com/brainfoolong/form-data-json
 "use strict";
 
 /**

diff --git a/dist/form-data-json.min.js b/dist/form-data-json.min.js
diff --git a/docs/scripts/form-data-json.es6.js b/docs/scripts/form-data-json.es6.js
@@ -1,4 +1,4 @@
-// form-data-json-convert | version: 2.2.1 | url: https://github.com/brainfoolong/form-data-json
+// form-data-json-convert | version: 2.2.2 | url: https://github.com/brainfoolong/form-data-json
 /**
  * Form Data Json Converter
  * @link https://github.com/brainfoolong/form-data-json

diff --git a/docs/scripts/form-data-json.js b/docs/scripts/form-data-json.js
@@ -1,4 +1,4 @@
-// form-data-json-convert | version: 2.2.1 | url: https://github.com/brainfoolong/form-data-json
+// form-data-json-convert | version: 2.2.2 | url: https://github.com/brainfoolong/form-data-json
 "use strict";
 
 /**

diff --git a/docs/scripts/form-data-json.min.js b/docs/scripts/form-data-json.min.js
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "type": "git",
     "url": "git+https://github.com/brainfoolong/form-data-json.git"
   },
-  "version": "2.2.1",
+  "version": "2.2.2",
   "scripts": {
     "dist": "node build/dist.js"
   },