Add TS typings

Author: ilyalesik

README.md

@@ -6,6 +6,8 @@
 
 React hook for conveniently use Fetch API.
 
+Both **Flow** and **TS** types included.
+
 ```javascript
 import React from "react";
 import { useFetch } from "react-fetch-hook";

package-lock.json

@@ -1,14 +1,16 @@
 {
   "name": "react-fetch-hook",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "React fetch hook",
   "main": "./dist/index.js",
   "scripts": {
     "flow": "flow",
     "flow:check": "flow check",
+    "typescript": "tsc -p tsconfig.json --noEmit",
+    "copy:ts": "cp ./src/index.d.ts ./dist/index.d.ts",
     "test": "jest --silent",
     "prettier": "prettier \"*/**/*.js\" --ignore-path ./.prettierignore --write && git add . && git status",
-    "build": "npm run build:clean && npm run build:lib && npm run build:flow",
+    "build": "npm run build:clean && npm run build:lib && npm run build:flow && npm run copy:ts",
     "build:clean": "rimraf dist",
     "build:lib": "cross-env BABEL_ENV=production babel src --out-dir dist --ignore '**/__tests__/**'",
     "build:flow": "gen-flow-files src --out-dir dist",
@@ -68,6 +70,7 @@
     "react-dom": "^16.8.0",
     "react-test-renderer": "^16.8.0",
     "react-testing-library": "^6.0.0",
-    "rimraf": "^2.6.2"
+    "rimraf": "^2.6.2",
+    "typescript": "^3.4.5"
   }
 }

package.json

@@ -0,0 +1,37 @@
+
+interface FetchResult<T> {
+    data?: T,
+    isLoading: boolean,
+    error?: any
+}
+
+interface HookOptions extends RequestInit {
+    depends?: Array<any>
+}
+
+interface HookOptionsWithFormatter<T> extends HookOptions {
+    formatter(response: Response): Promise<T>
+}
+
+export function useFetch<T>(path: RequestInfo,
+                     options?: HookOptions | HookOptionsWithFormatter<T>,
+                     specialOptions?: HookOptions): FetchResult<T>;
+
+type requestFunction<T> = (params: {
+    limit: number,
+    offset: number,
+}) => Promise<Array<T>>
+
+export function usePaginatedRequest<T>(request: requestFunction<T>, limit: number): {
+    data: Array<T>,
+    loadMore?: () => any,
+    hasMore: boolean,
+};
+
+type TUsePromiseResult<T> = {
+    data?: T,
+    isLoading: boolean,
+    error: any,
+};
+export function flattenInput(...inputs: Array<any>): Array<any>;
+export function usePromise<T, I extends Array<any>>(callFunction?: (...args: I) => Promise<T>, ...inputs: I): TUsePromiseResult<T>;

src/index.d.ts

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "jsx": "react",
+    "lib": [
+      "dom",
+      "es2018"
+    ],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitAny": false,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strict": true,
+    "strictFunctionTypes": false,
+    "stripInternal": true
+  },
+  "include": [
+    "**/*.d.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}