Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brettz9/getjson
Vanilla JS getJSON function
https://github.com/brettz9/getjson
getjson json promise
Last synced: 19 days ago
JSON representation
Vanilla JS getJSON function
- Host: GitHub
- URL: https://github.com/brettz9/getjson
- Owner: brettz9
- License: mit
- Created: 2014-12-08T21:31:55.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-19T22:36:22.000Z (about 2 months ago)
- Last Synced: 2024-10-25T14:31:09.681Z (21 days ago)
- Topics: getjson, json, promise
- Language: JavaScript
- Size: 1.59 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE-MIT.txt
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/simple-get-json)
[](https://david-dm.org/brettz9/getJSON)
[](https://david-dm.org/brettz9/getJSON?type=dev)
[](badges/eslint-badge.svg)
[](badges/eslint-third-party.svg)
[](badges/tests-badge.svg)
[](badges/coverage-badge.svg)
[](https://snyk.io/test/github/brettz9/getJSON)
[](https://lgtm.com/projects/g/brettz9/getJSON/alerts)
[](https://lgtm.com/projects/g/brettz9/getJSON/context:javascript)
[](badges/filesize-browser-umd.svg)
[](badges/filesize-browser-esm.svg)
[](badges/licenses-badge.svg)
(see also [licenses for dev. deps.](https://raw.githubusercontent.com/brettz9/getJSON/master/badges/licenses-badge-dev.svg?sanitize=true))
[](https://issuehunt.io/r/brettz9/getJSON)
# getJSON
getJSON function similar to that of jQuery's.
If no callback or error-back is provided (or when an array of URLs is
supplied), a promise will be returned. If an array is provided along with
a callback, that callback will be executed before the promise is resolved.
You may use the file `index-es.js` to use the ES2017 `await` keyword for
Promise results, as well as take advantage of ES6 Module import:
```js
try {
const [urlObj1, urlObj2] = await getJSON([url1, url2]);
} catch (err) {
// Handle errors here
}
```
`simple-get-json` also accepts an array of URLs (waiting for all to load):
```js
const [obj1, obj2] = await getJSON([url1, url2]);
// Do something with "obj1" and "obj2"
```
Alternatively, you can use regular `then` Promises:
```js
getJSON([url1, url2]).then(function (objsArr) {
// Do something with "objsArr" array
}, function (err) {
// Handle any errors here
console.log('err', err);
});
```
Or use the old callback style.
```js
getJSON(url, function (data) {
// Do something with "data"
});
```
An optional third argument can be provided as an error-back (which will
be supplied the error message and originally supplied URL).
## Install
```
npm install simple-get-json
```
## Setup
### Browser
```html
```
```js
getJSON(...args);
```
or for ESM:
1. Direct use:
```js
import {getJSON} from './node_modules/simple-get-json/dist/index-es.js';
```
2. With a bundler:
```js
import {getJSON} from 'simple-get-json';
```
### Node (CJS)
```js
const {getJSON} = require('simple-get-json');
```
See below for `buildGetJSON` usage.
### Node (ESM)
In ESM Node, you can:
1. Directly import the module (for use relative to the current working
directory):
```js
import {getJSON} from 'simple-get-json';
```
2. Build a version of `getJSON` which works relative to the current file
(or some other URL):
```js
import {buildGetJSON} from 'simple-get-json';
const getJSON = buildGetJSON({
baseURL: import.meta.url
});
```
OR:
3. Build a version of `getJSON` which works relative to a specific file
directory:
```js
import {buildGetJSON} from 'simple-get-json';
const getJSON = buildGetJSON({
cwd: '/some/current/working/directory'
});
```
## Todo
- Support named parameters ala jQuery
- Support rest of jQuery API
- Make local or URL loading optional for Node
## See also
- [postJSON](https://github.com/brettz9/postJSON)