Table of contents

• Documentation

• Change log

• Installation

  • From NPM

  • From CDN

• Support

• Examples

• License

Documentation

cherjs.org

Change log

CHANGELOG.md

Installation

From NPM

It can be installed as an NPM package in a project directory by running the command below:

npm install cherjs@latest

Then it can be imported for use as an ES module:

import cher from 'cherjs';

Or as a CommonJS module:

const cher = require('cherjs');

The imported cher variable contains a Cher instance.

From CDN

Insert the following code snippet into the HTML code (this loads the minified production version):

<script src="https://unpkg.com/cherjs"></script>

Or, if the uncompressed version is needed, then

<script src="https://unpkg.com/cherjs/dist/cher.umd.js"></script>

After that, a Cher instance named cher is available in the global scope, that is, as the cher property of the global window object (so as window.cher).

Support

Cher and fetch API support can be checked with the read-only supported boolean property of a Cher instance:

if (cher.supported) {
	// fetch API is supported
}
else {
	// fetch API is not supported
}

See the compatibility table on MDN for browser and runtime environment support for fetch API.

Examples

Each Cher instance is a reusable agent, meaning it can be used to initiate requests multiple times.

// Import the initial Cher instance
import cher from 'cherjs';

// ...

let wikipediaLogo;

// Get Wikipedia logo
cher(
	'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
	{
		decode: 'file',
	},
)
.then(
	(response) => {
		wikipediaLogo = response.data;
	},
);

// ...

// Again: cher() and cher.fetch() are the same
cher.fetch(
	{
		url: 'https://en.wikipedia.org/static/images/project-logos/enwiki.png',
		decode: 'file',
	},
)
.then(
	(response) => {
		wikipediaLogo = response.data;
	},
);

// ...

// Create a new Cher instance
const worldTime = cher.create();
// Set the base URL
worldTime.baseURL = 'http://worldtimeapi.org/api/timezone/';
// Complete the base URL
worldTime.baseURL = '{area}/';

// ...

// Create a new Cher instance with the previous configuration
const europeTime = worldTime.create(true);
// Complete the configuration
europeTime.args = {
	area: 'Europe',
};

// ...

let romeTime;

// Get Rome time
europeTime('Rome')
.then(
	(response) => {
		romeTime = response.data;
	},
);

// ...

// Complete the base URL
europeTime.baseURL = '{location}';

// Update the Rome time
europeTime(
	{
		args: {
			location: 'Rome',
		},
	},
)
.then(
	(response) => {
		romeTime = response.data;
	},
);

// ...

let reykjavikTime;

// Get a Europe time (Reykjavik, Iceland) from another area
europeTime(
	{
		args: {
			area: 'Atlantic',
			location: 'Reykjavik',
		},
	},
)
.then(
	(response) => {
		reykjavikTime = response.data;
	},
);

License

The MIT License (MIT)

Copyright © 2022-present Haász Sándor

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.