# easy-html-injector
> A simple HTML injector for Node.js
Latest version **1.0.6** (published 2023-03-13) · ISC license · 0 weekly downloads
## Install
```sh
npm install easy-html-injector
pnpm add easy-html-injector
yarn add easy-html-injector
bun add easy-html-injector
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities; high quality score.
Warnings: low downloads.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-03-13 |
| First published | 2023-03-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | ialdama |
## Links
- npm: https://www.npmjs.com/package/easy-html-injector
- npm.io page: https://npm.io/package/easy-html-injector
## Recent versions
- 1.0.6 (latest) — 2023-03-13
- 1.0.5 — 2023-03-13
- 1.0.4 — 2023-03-13
- 1.0.3 — 2023-03-13
- 1.0.2 — 2023-03-13
- 1.0.0 — 2023-03-13
## README
# easy-html-injector
## Introduction
easy-html-injector is a simple Node module that allows you to inject HTML elements into an HTML string. The package exports a single function `inject(html: string, element: HtmlElement)` that takes an HTML string and an object representing an HTML element to be injected, and returns the modified HTML string with the new element inserted at the specified position.
### Installation
To install `easy-html-injector`, use pnpm, npm, or yarn:
```bash
pnpm add easy-html-injector
```
```bash
npm install easy-html-injector
```
```bash
yarn add easy-html-injector
```
### Usage
First, import the inject function:
```javascript
import { inject } from 'easy-html-injector';
```
The inject function takes two arguments:
- `html`: A string containing the HTML that you want to modify.
- `element`: An object representing the HTML element that you want to inject. The object has the following properties:
- `parent`: A string representing the parent element into which the new element will be injected. This can be 'head', 'body', or any other valid HTML element tag name.
- `position`: A string representing the position at which the new element will be inserted. This can be 'prepend' or 'append'.
- `tag`: A string representing the tag name of the new element.
- `content` (optional): A string representing the content to be inserted into the new element.
- `attributes` (optional): An object representing the attributes to be added to the new element. The keys of the object represent attribute names, and the values represent attribute values.
Here is an example usage:
```javascript
const html = `
My page
Hello, world!
`;
const newElement = {
parent: 'head',
position: 'prepend',
tag: 'meta',
attributes: {
charset: 'utf-8',
},
};
const modifiedHtml = inject(html, newElement);
console.log(modifiedHtml);
```
This will output:
```html
My page
Hello, world!
```
## License
`easy-html-injector` is released under the MIT License. See the LICENSE file for more details.
## Benchmark
| Benchmark | Average | Min | Max | Median | Std Dev | Variance | Ops | Ops/sec |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| inject | 0.016 | 0.0030 | 0.11 | 0.0043 | 0.032 | 2.0 | 62631 | 62630905 |
| cheerio | 0.87 | 0.35 | 4.5 | 0.43 | 1.2 | 1.4 | 1147 | 1146707 |
---
_Source: https://npm.io/package/easy-html-injector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._