├── .babelrc ├── .editorconfig ├── .eslintrc ├── .gitignore ├── .prettierrc.json ├── LICENSE ├── README.md ├── index.d.ts ├── package.json ├── src └── index.js ├── test └── noop.test.js └── yarn.lock /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": ["@babel/env", "@babel/react"] 3 | } -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig helps developers define and maintain 2 | # consistent coding styles between different editors and IDEs. 3 | 4 | root = true 5 | 6 | [*] 7 | end_of_line = lf 8 | charset = utf-8 9 | trim_trailing_whitespace = true 10 | insert_final_newline = true 11 | indent_style = space 12 | indent_size = 2 13 | 14 | [*.md] 15 | trim_trailing_whitespace = false 16 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "parser": "babel-eslint", 3 | "extends": [ 4 | "standard", 5 | "standard-jsx" 6 | ], 7 | "rules": { 8 | "jsx-quotes": [ 9 | "error", 10 | "prefer-double" 11 | ], 12 | "comma-dangle": [ 13 | "error", 14 | "always-multiline" 15 | ] 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | dist/ 64 | es/ 65 | lib/ -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "semi": false, 3 | "singleQuote": true, 4 | "trailingComma": "all" 5 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 Seyyed Morteza Moosavi 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # react-use-data-loader 2 | 3 | React hook for loading data 4 | 5 | # Installation 6 | 7 | Using npm: 8 | 9 | ``` 10 | $ npm install --save react-use-data-loader 11 | ``` 12 | 13 | Using yarn: 14 | 15 | ``` 16 | $ yarn add react-use-data-loader 17 | ``` 18 | 19 | Since this module uses React's upcoming Hooks feature, to try this out you'll need to install the 16.7.0-alpha.0 version of react and react-dom: 20 | 21 | ``` 22 | $ yarn add react@16.7.0-alpha.0 react-dom@16.7.0-alpha.0 23 | ``` 24 | 25 | # Usage 26 | 27 | ```jsx 28 | import React from 'react' 29 | import { useDataLoader } from 'react-use-data-loader' 30 | 31 | async function getData(id) { 32 | /* async api call */ 33 | 34 | return 'item ' + id 35 | } 36 | 37 | function Example({ id }) { 38 | const { data, error, loading, retry } = useDataLoader(getData, id) 39 | 40 | if (loading) { 41 | return
loading...
42 | } 43 | 44 | if (error) { 45 | return
Error
46 | } 47 | 48 | return 49 | } 50 | 51 | function App() { 52 | return 53 | } 54 | ``` 55 | 56 | # API 57 | 58 | ```ts 59 | 60 | useDataLoader(getData: GetData, ...args: Args) => ({ 61 | data: Data | null, 62 | error: Error | null, 63 | loading: boolean, 64 | retry: Retry, 65 | }) 66 | 67 | type GetData = (...args: Args) => Promise 68 | type Retry = () => void 69 | 70 | ``` -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | export function useDataLoader( 2 | getData: (...args: Args) => Promise, 3 | ...args: Args 4 | ): { 5 | data: Data | null 6 | error: Error | null 7 | loading: boolean 8 | retry: () => void 9 | } 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-use-data-loader", 3 | "version": "0.0.3", 4 | "description": "React hook for loading data", 5 | "main": "dist/index.js", 6 | "typings": "./index.d.ts", 7 | "repository": "git@github.com:smmoosavi/react-use-data-loader.git", 8 | "author": "Seyyed Morteza Moosavi ", 9 | "license": "MIT", 10 | "files": [ 11 | "dist", 12 | "src", 13 | "index.d.ts" 14 | ], 15 | "keywords": [ 16 | "react", 17 | "react-hooks", 18 | "load-data" 19 | ], 20 | "scripts": { 21 | "clean": "rimraf lib dist es coverage", 22 | "test": "jest", 23 | "build": "babel src --out-dir dist", 24 | "format": "prettier --write '{src,test}/**/*.js'", 25 | "format:check": "prettier --list-different '{src,test}/**/*.js'", 26 | "lint": "eslint src test", 27 | "prepare": "npm run clean && npm run format:check && npm run lint && npm test && npm run build" 28 | }, 29 | "devDependencies": { 30 | "@babel/cli": "^7.5.0", 31 | "@babel/core": "^7.5.0", 32 | "@babel/preset-env": "^7.5.0", 33 | "@babel/preset-react": "^7.0.0", 34 | "babel-core": "^7.0.0-bridge.0", 35 | "babel-eslint": "^10.0.2", 36 | "babel-jest": "^24.8.0", 37 | "cross-env": "^5.2.0", 38 | "eslint": "^6.0.1", 39 | "eslint-config-standard": "^12.0.0", 40 | "eslint-config-standard-jsx": "^6.0.2", 41 | "eslint-plugin-import": "^2.18.0", 42 | "eslint-plugin-node": "^9.1.0", 43 | "eslint-plugin-promise": "^4.2.1", 44 | "eslint-plugin-react": "^7.14.2", 45 | "eslint-plugin-standard": "^4.0.0", 46 | "husky": "^3.0.0", 47 | "jest": "^24.8.0", 48 | "prettier": "^1.18.2", 49 | "rimraf": "^2.6.3" 50 | }, 51 | "husky": { 52 | "hooks": { 53 | "pre-commit": "npm run format:check && npm run lint && npm test" 54 | } 55 | }, 56 | "jest": { 57 | "testRegex": "(/test/.*\\.test.js)$", 58 | "collectCoverage": true 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import { useEffect, useState, useReducer } from 'react' 2 | 3 | const reducer = (state, action) => { 4 | switch (action.type) { 5 | case 'get': 6 | return { ...state, loading: true } 7 | case 'success': 8 | return { 9 | ...state, 10 | data: action.payload.data, 11 | error: null, 12 | loading: false, 13 | } 14 | case 'error': 15 | return { 16 | ...state, 17 | data: null, 18 | error: action.payload.error, 19 | loading: false, 20 | } 21 | default: 22 | return state 23 | } 24 | } 25 | 26 | export const useDataLoader = (getData, ...args) => { 27 | const [nonce, setNonce] = useState(Date.now()) 28 | const [state, dispatch] = useReducer(reducer, { 29 | data: null, 30 | error: null, 31 | loading: true, 32 | }) 33 | 34 | useEffect(() => { 35 | let cancel = false 36 | 37 | dispatch({ type: 'get' }) 38 | getData(...args) 39 | .then(data => { 40 | !cancel && dispatch({ type: 'success', payload: { data } }) 41 | }) 42 | .catch(error => { 43 | !cancel && dispatch({ type: 'error', payload: { error } }) 44 | }) 45 | 46 | return () => { 47 | cancel = true 48 | } 49 | }, [nonce, ...args]) 50 | 51 | const retry = () => { 52 | setNonce(Date.now()) 53 | } 54 | 55 | return { ...state, retry } 56 | } 57 | -------------------------------------------------------------------------------- /test/noop.test.js: -------------------------------------------------------------------------------- 1 | /* eslint-env node, jest */ 2 | 3 | test('noop', () => { 4 | expect(1).toBe(1) 5 | }) 6 | --------------------------------------------------------------------------------