From f109e22895132a4cbcc23ba714dc935a933e8fb8 Mon Sep 17 00:00:00 2001 From: Tyler Johnson Date: Mon, 23 Jul 2018 12:37:05 -0600 Subject: [PATCH] Add typings for form-serialize (#27403) * add form-serialize * minor changes to more accurately describe form-serialize defaults --- types/form-serialize/form-serialize-tests.ts | 17 +++++++++ types/form-serialize/index.d.ts | 37 ++++++++++++++++++++ types/form-serialize/tsconfig.json | 24 +++++++++++++ types/form-serialize/tslint.json | 3 ++ 4 files changed, 81 insertions(+) create mode 100644 types/form-serialize/form-serialize-tests.ts create mode 100644 types/form-serialize/index.d.ts create mode 100644 types/form-serialize/tsconfig.json create mode 100644 types/form-serialize/tslint.json diff --git a/types/form-serialize/form-serialize-tests.ts b/types/form-serialize/form-serialize-tests.ts new file mode 100644 index 0000000000..42b587dd80 --- /dev/null +++ b/types/form-serialize/form-serialize-tests.ts @@ -0,0 +1,17 @@ +import serialize = require("form-serialize"); + +const form = document.createElement("form"); +serialize(form, { hash: true }); // $ExpectType ResultHash +serialize(form, true); // $ExpectType ResultHash +serialize(form, { hash: false }); // $ExpectType string +serialize(form, false); // $ExpectType string +serialize(form); // $ExpectType string + +interface CustomResult { + foo: string; +} + +// $ExpectType CustomResult +serialize(form, { + serializer: (): CustomResult => ({ foo: "bar" }) +}); diff --git a/types/form-serialize/index.d.ts b/types/form-serialize/index.d.ts new file mode 100644 index 0000000000..b433f6b81b --- /dev/null +++ b/types/form-serialize/index.d.ts @@ -0,0 +1,37 @@ +// Type definitions for form-serialize 0.7 +// Project: https://github.com/defunctzombie/form-serialize#readme +// Definitions by: Tyler Johnson +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +interface ResultHash { + [key: string]: string | string[] | ResultHash; +} + +interface Options { + /** Configure the output type. If true, the output will be a js object. */ + hash?: boolean; + /** + * Optional serializer function to override the default one. The function takes 3 arguments (result, key, + * value) and should return new result hash and url encoded str serializers are provided with this module + */ + serializer?: (result: Result, key: string, value: string) => Result; + /** If true serialize disabled fields. */ + disabled?: boolean; + /** If true serialize empty fields */ + empty?: boolean; +} + +interface OptionsHash extends Options { + hash: true; +} + +interface OptionsString extends Options { + hash: false; +} + +declare function serialize(form: HTMLFormElement, options: OptionsHash | true): ResultHash; +declare function serialize(form: HTMLFormElement, options?: OptionsString | false): string; +declare function serialize(form: HTMLFormElement, options?: Options | boolean): Result; + +export = serialize; diff --git a/types/form-serialize/tsconfig.json b/types/form-serialize/tsconfig.json new file mode 100644 index 0000000000..b37dff4ca2 --- /dev/null +++ b/types/form-serialize/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "form-serialize-tests.ts" + ] +} diff --git a/types/form-serialize/tslint.json b/types/form-serialize/tslint.json new file mode 100644 index 0000000000..f93cf8562a --- /dev/null +++ b/types/form-serialize/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "dtslint/dt.json" +}