# rfg-api

> RealFaviconGenerator API

Latest version **0.5.3** (published 2023-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install rfg-api
pnpm add rfg-api
yarn add rfg-api
bun add rfg-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2023-03-05 |
| First published | 2015-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 5 |
| Unpacked size | 636.3 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 41 |
| Author | Philippe Bernard |
| Maintainers | pbernard_rfg |
| Keywords | node, favicon, realfavicongenerator |

## Links

- npm: https://www.npmjs.com/package/rfg-api
- Repository: https://github.com/RealFaviconGenerator/rfg-api
- Issues: https://github.com/RealFaviconGenerator/rfg-api/issues
- npm.io page: https://npm.io/package/rfg-api

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [fstream](https://npm.io/package/fstream.md) ^1.0.2
- [metaparser](https://npm.io/package/metaparser.md) ^1.0.7
- [node-unzip-2](https://npm.io/package/node-unzip-2.md) ^0.2.7

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.5.3 (latest) — 2023-03-05
- 0.5.2 — 2021-03-31
- 0.5.1 — 2020-02-04
- 0.5.0 — 2019-01-22
- 0.4.0 — 2018-12-03
- 0.3.0 — 2016-12-08
- 0.2.0 — 2016-09-02
- 0.1.7 — 2016-01-20
- 0.1.6 — 2016-01-19
- 0.1.4 — 2015-12-23
- 0.1.3 — 2015-11-18
- 0.1.2 — 2015-11-10
- 0.1.1 — 2015-11-09
- 0.1.0 — 2015-11-07
- 0.0.3 — 2015-11-02
- … 2 more at https://npm.io/package/rfg-api/versions

## README

# rfg-api

Implementation of the [RealFaviconGenerator API](http://realfavicongenerator.net/api)
for [Node.js](https://nodejs.org).

## Getting Started

This plugin implements the
[non-interactive API of RealFaviconGenerator.net](https://realfavicongenerator.net/api/non_interactive_api).
This API lets you create favicons for all platforms: desktop browsers, iOS, Android, etc.

To install it:

```shell
npm install rfg-api --save
```

## Release History

### 0.5.3

- Fix https://github.com/RealFaviconGenerator/rfg-api/issues/25 regarding `master-picture`.
- Several dependencies updated thanks to `npm audit fix`.

### 0.5.2

- Update dependencies to fix vulnerabilities, see https://github.com/RealFaviconGenerator/rfg-api/pull/23, https://github.com/RealFaviconGenerator/rfg-api/pull/22 and https://github.com/RealFaviconGenerator/rfg-api/pull/21
- Merge https://github.com/RealFaviconGenerator/rfg-api/pull/26 to fix https://github.com/RealFaviconGenerator/realfavicongenerator/issues/267, https://github.com/RealFaviconGenerator/gulp-real-favicon/issues/21 and https://github.com/RealFaviconGenerator/grunt-real-favicon/issues/43
- Merge https://github.com/RealFaviconGenerator/rfg-api/pull/24 to fix https://github.com/RealFaviconGenerator/realfavicongenerator/issues/449 and https://github.com/RealFaviconGenerator/realfavicongenerator/issues/458

### 0.5.1

- Update dependencies to fix vulnerabilities, see https://github.com/RealFaviconGenerator/rfg-api/pull/18, https://github.com/RealFaviconGenerator/rfg-api/pull/19, https://github.com/RealFaviconGenerator/rfg-api/pull/20 and https://github.com/RealFaviconGenerator/rfg-api/pull/21

### 0.5.0

- Switch from `unzip2` to `node-unzip-2`. See https://github.com/RealFaviconGenerator/rfg-api/pull/15

### 0.4.0

- Switch from `node-rest-client` to `axios` in order to fix vulnerabilities introduced by `node-rest-client` dependencies. See https://github.com/RealFaviconGenerator/rfg-api/issues/14

### 0.3.0

- Accept both base64 and file name for the "inline" type. See https://github.com/RealFaviconGenerator/rfg-api/issues/10

### 0.2.0

- Switch from `unzip` to `unzip2`. See https://github.com/RealFaviconGenerator/rfg-api/issues/8

### 0.1.7

- `injectFaviconMarkups` supports a `keep` option.

### 0.1.6

- Fix for `existing_manifest`.

### 0.1.5

- Add `escapeJSONSpecialChars`.

### 0.1.4

- Switch to HTTPS.

### 0.1.3

- Existing `rel=mask-icon` markups are filtered-out.

### 0.1.2

- Improvement in `normalizeMasterPicture`.

### 0.1.1

- `changeLog` added.

### 0.1.0

- `injectFaviconMarkups` now takes the HTML content directly, not a file name.

### 0.0.3

- In case of API invocation error, the error is transmitted to the callback
(instead of being thrown).

### 0.0.2

- Refactoring

### 0.0.1

- Initial release

---
_Source: https://npm.io/package/rfg-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
