Merge pull request #8 from github/add-typescript-definition-file

Add typescript definition file

Author: koddsson

index.d.ts

@@ -0,0 +1,28 @@
+type Kicker = {
+  text: () => Promise<SimpleResponse>,
+  json: () => Promise<SimpleResponse>,
+  html: () => Promise<SimpleResponse>
+}
+
+type SimpleRequest = {
+  method: string,
+  url: string,
+  body: FormData | null,
+  headers: Headers
+}
+
+export type SimpleResponse = {
+  url: string,
+  status: number,
+  statusText: string,
+  headers: Headers,
+  text: string,
+  json: {[key: string]: any},
+  html: DocumentFragment
+}
+
+export type RemoteFormHandler = (form: HTMLFormElement, kicker: Kicker, req: SimpleRequest) => void | Promise<void>;
+export function afterRemote(fn: (form: HTMLFormElement) => void): void;
+export function beforeRemote(fn: (form: HTMLFormElement) => void): void;
+export function remoteForm(selector: string, fn: RemoteFormHandler): void;
+export function remoteUninstall(selector: string, fn: RemoteFormHandler): void;

package.json

@@ -4,10 +4,12 @@
   "description": "Decorator that will submit a form over AJAX",
   "repository": "github/remote-form",
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
   "main": "dist/index.umd.js",
   "module": "dist/index.esm.js",
+  "types:": "index.d.ts",
   "scripts": {
     "clean": "rm -rf dist",
     "lint": "github-lint",

src/index.js

@@ -50,7 +50,7 @@ type SimpleRequest = {
 export type SimpleResponse = {
   url: string,
   status: number,
-  statusText: ?string,
+  statusText: string,
   headers: Headers,
   text: string,
   // eslint-disable-next-line flowtype/no-weak-types

src/index.js.flow

@@ -16,15 +16,15 @@ type SimpleRequest = {
 export type SimpleResponse = {
   url: string,
   status: number,
-  statusText: ?string,
+  statusText: string,
   headers: Headers,
   text: string,
   json: {[string]: any},
   html: DocumentFragment
 }
 export type RemoteFormHandler = (form: HTMLFormElement, kicker: Kicker, req: SimpleRequest) => void | Promise<void>;
 
-declare export function afterRemote(fn: (form: HTMLFormElement) => mixed): void;
-declare export function beforeRemote(fn: (form: HTMLFormElement) => mixed): void;
+declare export function afterRemote(fn: (form: HTMLFormElement) => void): void;
+declare export function beforeRemote(fn: (form: HTMLFormElement) => void): void;
 declare export function remoteForm(selector: string, fn: RemoteFormHandler): void;
 declare export function remoteUninstall(selector: string, fn: RemoteFormHandler): void;