Merge pull request #6 from charjac/CHORE/TYPINGS

add ts typings

index.d.ts

@@ -0,0 +1,27 @@
+declare module 'use-form-react' {
+ import React from 'react';
+ export type ValidationFunc<Fields> = (fields: Fields) => string | undefined;
+
+ export interface UseFormConfig<Fields extends Record<string, any>> {
+ initialValues?: Partial<Fields>;
+ validation?: Partial<Record<keyof Fields, ValidationFunc<Fields>>>;
+ debug?: boolean;
+ callback?: (inputs: Fields)=> void;
+ }
+
+ export interface UseFormState<Fields> {
+ onSubmit: (event: React.SyntheticEvent<HTMLFormElement>) => void,
+ onChange: (event: React.SyntheticEvent<HTMLInputElement>) => void,
+ inputs: Fields,
+ submitting: boolean,
+ dirty: boolean,
+ reset: () => void,
+ setInputs: (fields: Fields) => void,
+ errors: Record<keyof Fields, string>,
+ valid: boolean,
+ }
+
+ const useForm: <Fields = any>(name: string, config: UseFormConfig<Fields>) => UseFormState<Fields>;
+
+ export default useForm;
+}

package.json

@@ -15,6 +15,7 @@
  "type": "git",
  "url": "https://github.com/amazingandyyy/use-form-react.git"
  },
+ "types": "index.d.ts",
  "peerDependencies": {
  "react": "^16.8.0"
  },
@@ -25,6 +26,7 @@
  "@babel/core": "^7.4.3",
  "@babel/preset-env": "^7.4.3",
  "@babel/preset-react": "^7.0.0",
+ "@types/react": "^16.8.18",
  "babel-jest": "^24.7.1",
  "jest": "^24.7.1",
  "parcel-bundler": "^1.12.3",