npmpackage.info

baseerr

2.0.6

MIT

TypeScript

1.48 kB

Installations

npm install baseerr

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

16.20.2

NPM Version

8.19.4 Score

72.9

Supply Chain

99.4

Quality

79.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

9

Total

14

Closed

2

Merged

3

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

TypeScript

TypeScript (100%)

Developer

tjmehta

Download Statistics

Total Downloads

80,811

Last Day

Last Week

108

Last Month

922

Last Year

21,332

GitHub Statistics

2 Stars

32 Commits

3 Watching

13 Branches

1 Contributors

Bundle Size

3.71 kB

Minified

1.48 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.0.6

Package Id

baseerr@2.0.6

Unpacked Size

37.71 kB

Size

8.39 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Publised On

17 Apr 2024

Total Downloads

Cumulative downloads

Total Downloads

80,811

Last day

-77.6%

Compared to previous day

Last week

-41.6%

108

Compared to previous week

Last month

-92.5%

922

Compared to previous month

Last year

13.9%

21,332

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

fast-safe-stringify

Dev Dependencies

@babel/preset-env @babel/preset-typescript @types/jest babel-core babel-jest escape-string-regexp jest prettier rewrite-cjs-esm-paths typescript

Versions

BaseErr

A solid BaseError class that supports custom properties and wrapping errors

Installation

1npm i --save baseerr

Usage

Create a custom error class

1import BaseError from 'baseerr'
2
3class CustomError extends BaseError {}
4
5const err = new CustomError('boom')
6console.log(err.name // 'CustomError'
7console.log(err.stack)
8// CustomError: boom
9//     anonymous (filename:5:17)

Wrap an error with a custom error class

1import BaseError from 'baseerr'
2
3class CustomError extends BaseError {}
4
5try {
6  throw new Error('pow')
7} catch (_err) {
8  const err = CustomError.wrap('caught error', _err)
9  console.log(err.stack)
10  // CustomError: caught error
11  //     anonymous (filename:8:17)
12  // ----
13  // Error: pow
14  //     anonymous (filename:6:9)
15}

Wrap an error with a custom error class in promise chain

1import BaseError from 'baseerr'
2
3class CustomError extends BaseError {}
4
5Promise.reject(new Error('pow')).catch((err) =>
6  CustomError.wrapAndThrow('caught error', err),
7)
8// rejects with:
9// CustomError: caught error
10//     anonymous (filename:6:3)
11// ----
12// Error: pow
13//     anonymous (filename:5:16)

Create custom error instance with data properties

1import BaseError from 'baseerr'
2
3class CustomError extends BaseError {}
4
5const err = new CustomError('boom', { foo: 10, bar: 20 })
6console.log(err.foo) // 10
7console.log(err.bar) // 20
8console.log(err.stack)
9// CustomError: boom
10//     anonymous (filename:5:17)
11// {
12//   "foo": 10,
13//   "bar": 20
14// }
15
16// TypeScripters use BaseError.create if you want to access extended properties with proper typing:
17const err = CustomError.create('boom', { foo: 10, bar: 20 })
18console.log(err.foo) // 10
19console.log(err.bar) // 20

Create custom api client with robust error handling

1import BaseError from 'baseerr'
2
3class FetchError extends BaseError {}
4class ResponseError extends BaseError {}
5class ApiError extends BaseError {}
6
7class ApiClient {
8  getData() {
9    const url = 'https://localhost:3000'
10    try {
11      const res = await Promise.race([
12        timeout(2000).then(() => {
13          throw new TimeoutError('request timed out', { statusCode: 504, url })
14        }),
15        fetch(url).catch(
16          FetchError.wrapAndThrow('network error', { statusCode: 503, url }),
17        ),
18      ])
19      if (res.statusCode !== 200) {
20        throw new ResponseError('status: ${res.statusCode}', {
21          statusCode: res.statusCode,
22          url,
23        })
24      }
25      return await res.json()
26    } catch (err) {
27      throw ApiError.wrap(err, { url, statusCode: err.statusCode || 500 })
28      // ApiError: boom
29      //     anonymous (filename:row:col)
30      // {
31      //   "url": 'https://localhost:3000',
32      //   "statusCode": 504
33      // }
34      // ----
35      // TimedoutError: request timed out
36      //     anonymous (filename:row:col)
37      // {
38      //   "url": 'https://localhost:3000',
39      //   "statusCode": 504
40      // }
41    }
42  }
43}

Checkout the tests for more examples..

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2024-12-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to baseerr

@paladen/errors

1.9.3

BaseError etc. All errors extend this.

@orderlycode/common

0.1.1

- BaseError - genId - HttpError - kst - kstDate - Dayjs - sleep

@serejke/ts-ninja-error

0.0.4

Extendable BaseError class