# html-speed

> Node.js library for PageIsight Test with Console output

Latest version **1.0.3** (published 2022-09-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install html-speed
pnpm add html-speed
yarn add html-speed
bun add html-speed
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-09-09 |
| First published | 2022-09-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 387.3 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | andreymatin |

## Links

- npm: https://www.npmjs.com/package/html-speed
- npm.io page: https://npm.io/package/html-speed

## Dependencies (5)

- [gulp](https://npm.io/package/gulp.md) ^4.0.2
- [axios](https://npm.io/package/axios.md) ^0.27.2
- [chalk](https://npm.io/package/chalk.md) ^5.0.1
- [express](https://npm.io/package/express.md) ^4.18.1
- [nodemon](https://npm.io/package/nodemon.md) ^2.0.19

## Recent versions

- 1.0.3 (latest) — 2022-09-09
- 1.0.2 — 2022-09-09
- 1.0.1 — 2022-09-09
- 1.0.0 — 2022-09-09

## README

# HTML Speed Test

_Node.js library for testing URL by PageSpeed Insight with Gulp.js compatibilities_

[![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/andreymatin/html-speed/LICENSE)
[![npm](https://img.shields.io/npm/v/html-speed.svg)](https://www.npmjs.com/package/html-speed)

<img src=https://raw.githubusercontent.com/andreymatin/html-speed/main/screenshot.png alt=screenshot width=640>

## How to install

### API key

Before start you need to generate Google API key and add Google Search Console API into your Google APIs dashboard.

https://developers.google.com/speed/docs/insights/v5/get-started


### npm

```shell
npm i html-speed
```

### yarn

```shell
yarn add html-speed
```

## How to use

```javascript
import htmlSpeed from 'html-speed'

const apiKey = ''
const url = ''

htmlSpeed(url, apiKey)
```

## Gulp.js integration

```javascript
import gulp from 'gulp'
const { parallel } = gulp

import htmlSpeed from 'html-speed'

const apiKey = ''
const url = ''

const htmlSpeedRes = () =>
  htmlSpeed(url, apiKey)

export default
  parallel(
    htmlSpeedRes
  )
```

## Reference

- https://web.dev/performance-scoring/
- https://developers.google.com/speed/docs/insights/v5/get-started

---
[MIT License](LICENSE)

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