brainfoolong / form-data-json

A zero dependency, cross browser library to easily get or set/manipulate form input values as/from a json object.
https://brainfoolong.github.io/form-data-json
MIT License
57 stars 10 forks source link

Typing of typescript Suggestion #36

Closed kurybr closed 5 months ago

kurybr commented 7 months ago

First, congratz of your job.

I use with typescript and want suggest a little help to other people

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;
  }
brainfoolong commented 7 months ago

Thx for the suggestions. I'll into that.

brainfoolong commented 5 months ago

Thx for the suggestion, the file is now added in 2.2.2.