├── .gitignore
├── LICENSE.md
├── README.md
├── example.png
├── index.js
├── package.json
└── yarn.lock
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log
3 | *.log.*
4 | .DS_Store
5 | package-lock.json
6 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Gabriel Escabora
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.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://www.npmjs.com/package/gatsby-plugin-cache-api)
2 | [](https://www.npmjs.com/package/gatsby-plugin-cache-api)
3 | [](https://github.com/escabora/gatsby-plugin-cache-api/blob/main/LICENSE.md)
4 | [](https://www.codefactor.io/repository/github/escabora/gatsby-plugin-cache-api)
5 |
6 | # gatsby-plugin-cache-api
7 |
8 | This plugin is used to cache any API.
9 |
10 | ## Install
11 |
12 | `$ npm i gatsby-plugin-cache-api`
13 |
14 | or
15 |
16 | `$ yarn add gatsby-plugin-cache-api`
17 |
18 | ## How to use
19 |
20 | import the function `cacheApi` in your `gatsby-node.js`.
21 |
22 | ```javascript
23 | const cacheApi = require('gatsby-plugin-cache-api');
24 |
25 | exports.onPreInit = async () => {
26 | const api = await fetch('https://dog.ceo/api/breeds/list/all');
27 | const json = await api.json();
28 |
29 | const defineCache = {
30 | pathOutput: 'js/json',
31 | nameOutPath: 'breeds.json',
32 | file: json.message,
33 | };
34 | cacheApi(defineCache);
35 | };
36 | ```
37 |
38 | In your component do a fetch directly in your application
39 |
40 | ```javascript
41 | const MyComponent = () => {
42 | const [breeds, setBreeds] = useState([]);
43 |
44 | useEffect(()=> {
45 | const api = await fetch('./js/json/breeds.json'); //- cache
46 | const json = await api.json();
47 | const parseBreeds = Object.keys(json.message)
48 | setBreeds(parseBreeds);
49 |
50 | }, [])
51 |
52 | return {breeds.map((breed)=>
{breed}
)}