# @yorkjs/web-error

> process web-error and report tool

Latest version **1.0.6** (published 2022-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @yorkjs/web-error
pnpm add @yorkjs/web-error
yarn add @yorkjs/web-error
bun add @yorkjs/web-error
```

## 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 | 2022-05-30 |
| First published | 2022-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | shushu2013 |
| Maintainers | shushu2013, musicode |
| Keywords | web-error |

## Links

- npm: https://www.npmjs.com/package/@yorkjs/web-error
- Repository: https://github.com/yorkjs/web-error
- Homepage: https://github.com/yorkjs/web-error#readme
- Issues: https://github.com/yorkjs/web-error/issues
- npm.io page: https://npm.io/package/@yorkjs/web-error

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2022-05-30
- 1.0.5 — 2022-03-28
- 1.0.4 — 2022-03-27
- 1.0.3 — 2022-02-20
- 1.0.2 — 2022-01-27
- 1.0.1 — 2022-01-27
- 1.0.0 — 2022-01-26

## README

# web-error
捕获页面异常，并上报

## 安装

### CDN

```html
<script src="https://unpkg.com/@yorkjs/web-error"></script>
```

### NPM

```shell
npm install @yorkjs/web-error
```

### YARN

```shell
yarn add @yorkjs/web-error
```

### 初始化

#### 提供了两种上传方式

```
webError.sendImage(url, queryStr)
webError.sendBeacon(url, data)
```

参考:

[Navigator.sendBeacon()](https://developer.mozilla.org/zh-CN/docs/Web/API/Navigator/sendBeacon)

#### ErrorMsg 对象

```
export interface ErrorMsg {
  url: string,
  type: number | string,
  error?: string,
  file?: string,
  line?: number,
  column?: number,
}
```

#### 使用示例

```js
import * as webError from '@yorkjs/web-error'

// 初始化需要的对象
// reportError 上报错误信息方法
webError.init({
  reportError(errObj) {
    // 方式一: 使用图片方式上传错误信息
    // 将错误对象处理成功 query 参数
    const query = formatMessage(errObj)
    webError.sendImage(url, query)

    // 方式二: 使用 Navigator.sendBeacon 方法
    webError.sendBeacon(url, errObj)
  },
})

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