10.0.0 • Published 9 months ago

simple-get-json v10.0.0

Weekly downloads
6
License
MIT
Repository
github
Last release
9 months ago

npm Dependencies devDependencies

eslint badge eslint 3rd party badge

testing badge coverage badge

Known Vulnerabilities Total Alerts Code Quality: Javascript

Filesize badge (UMD) Filesize badge (ESM)

Licenses badge

(see also licenses for dev. deps.)

issuehunt-to-marktext

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:

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):

const [obj1, obj2] = await getJSON([url1, url2]);
// Do something with "obj1" and "obj2"

Alternatively, you can use regular then Promises:

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.

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

<!--
For older browser support
<script src="node_modules/core-js-bundle/minified.js"></script>
-->
<script src="node_modules/simple-get-json/dist/index.js"></script>
getJSON(...args);

or for ESM:

  1. Direct use:
import {getJSON} from './node_modules/simple-get-json/dist/index-es.js';
  1. With a bundler:
import {getJSON} from 'simple-get-json';

Node (CJS)

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):
import {getJSON} from 'simple-get-json';
  1. Build a version of getJSON which works relative to the current file (or some other URL):
import {buildGetJSON} from 'simple-get-json';

const getJSON = buildGetJSON({
  baseURL: import.meta.url
});

OR:

  1. Build a version of getJSON which works relative to a specific file directory:
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

10.0.0

9 months ago

9.0.1

3 years ago

9.0.0

3 years ago

8.2.0

3 years ago

8.1.1

4 years ago

8.1.0

4 years ago

8.0.1

5 years ago

8.0.3

5 years ago

8.0.2

5 years ago

8.0.0

5 years ago

7.0.0

5 years ago

7.0.2

5 years ago

7.0.1

5 years ago

6.0.0

6 years ago

5.0.1

6 years ago

4.1.0

7 years ago

4.0.0

7 years ago

3.2.3

7 years ago

3.2.2

7 years ago

3.2.1

8 years ago

3.2.0

8 years ago

3.1.0

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.1.0

8 years ago

2.0.0

8 years ago

1.1.0

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago

0.3.2

10 years ago

0.3.1

10 years ago

0.3.0

10 years ago

0.2.6

10 years ago

0.2.0

10 years ago