mirror of https://github.com/iconify/iconify.git synced 2024-12-22 01:38:56 +00:00

History

Vjacheslav Trushkin 60baa1907c chore: update dependencies		2024-12-07 08:22:33 +02:00
..
src	chore: update deps, migrate api-redundancy to new eslint	2024-11-01 16:59:02 +02:00
tests	Switch api-redundancy package tests to vitest	2022-07-08 17:25:44 +03:00
.editorconfig	Create script for building ES and CommonJS libraries, move Utils and Core to new build process, move Redundancy package to monorepo and refactor it	2021-09-20 12:59:16 +03:00
.gitignore	Create script for building ES and CommonJS libraries, move Utils and Core to new build process, move Redundancy package to monorepo and refactor it	2021-09-20 12:59:16 +03:00
.npmignore	chore: update deps, migrate api-redundancy to new eslint	2024-11-01 16:59:02 +02:00
.prettierrc	Create script for building ES and CommonJS libraries, move Utils and Core to new build process, move Redundancy package to monorepo and refactor it	2021-09-20 12:59:16 +03:00
eslint.config.mjs	chore: update deps, migrate api-redundancy to new eslint	2024-11-01 16:59:02 +02:00
jest.config.js	Create script for building ES and CommonJS libraries, move Utils and Core to new build process, move Redundancy package to monorepo and refactor it	2021-09-20 12:59:16 +03:00
license.txt	chore: update readme files and license years	2023-05-31 22:04:11 +03:00
package.json	chore: update dependencies	2024-12-07 08:22:33 +02:00
pnpm-lock.yaml	Start moving to pnpm	2022-06-19 20:23:03 +03:00
README.md	chore: update readme files and license years	2023-05-31 22:04:11 +03:00
tsconfig.json	chore: remove importsNotUsedAsValues from all tsconfig files	2023-04-01 20:41:40 +03:00
vitest.config.mjs	Switch api-redundancy package tests to vitest	2022-07-08 17:25:44 +03:00

README.md

Redundancy

This package provides redundancy management for scripts that use API. It detects API connection timeouts and re-sends queries to backup API host(s).

It was designed to be used with Iconify icon components and plugins. It ensures that icon data is automatically retrieved from backup API in case main API server is unreachable, improving API uptime.

Usage

Due to time constraints, documentation is not available.

See lib/api/ in core package in sibling directory of this repository for usage.

License

This package is licensed under MIT license.

SPDX-License-Identifier: MIT

Previous versions of this package were dual-licensed under Apache 2.0 and GPL 2.0 licence, which was messy and confusing. This was later changed to MIT for simplicity.