npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

set-error-props

v6.0.0

Published

Properly update an error's properties

Downloads

35,638

Readme

Node Browsers TypeScript Codecov Minified size Mastodon Medium

Properly update an error's properties.

Hire me

Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.

Features

Example

import setErrorProps from 'set-error-props'

const error = new Error('one')
setErrorProps(error, { prop: true, message: 'two' })
console.log(error.prop) // true
console.log(error.message) // 'one': message is readonly

Install

npm install set-error-props

This package works in both Node.js >=18.18.0 and browsers.

This is an ES module. It must be loaded using an import or import() statement, not require(). If TypeScript is used, it must be configured to output ES modules, not CommonJS.

API

setErrorProps(error, props, options?)

error Error | object
props Error | object
options Options?
Return value: Error

Assigns props to error, then returns error.

Options

soft

Type: boolean
Default: false

Prevents overriding existing properties.

Usage

Error core properties

const error = new Error('one')
setErrorProps(error, { message: 'two' })
console.log(error.message) // 'one'

Prototype pollution

const error = new Error('one')
setErrorProps(error, { toString: () => 'injected' })
console.log(error.toString()) // 'Error: one'
console.log(Error.prototype.toString()) // 'Error'

Overriding protection

const error = new Error('message')
error.one = true
setErrorProps(error, { one: false, two: true }, { soft: true })
console.log(error.one) // true
console.log(error.two) // true

Error copy

const error = new Error('one')
const secondError = new Error('two')
secondError.prop = true
setErrorProps(error, secondError)
console.log(error.message) // 'one'
console.log(error.prop) // true

Non-enumerable properties

const error = new Error('message')

// Properties that start with `_` are not enumerable
setErrorProps(error, { _one: true, two: true })

console.log(error._one) // true
console.log(error.two) // true
console.log(Object.keys(error)) // ['two']
console.log(error) // Prints `two` but not `_one`

Descriptors

const error = new Error('message')
Object.defineProperty(error, 'prop', {
  value: false,
  enumerable: false,
  writable: true,
  configurable: true,
})
setErrorProps(error, { prop: true })
console.log(error.prop) // true
console.log(Object.getOwnPropertyDescriptor(error, 'prop').enumerable) // false

Exception safety

const error = new Proxy(new Error('message'), {
  set: () => {
    throw new Error('example')
  },
  defineProperty: () => {
    throw new Error('example')
  },
})
setErrorProps(error, { prop: true }) // This does not throw

Related projects

Support

For any question, don't hesitate to submit an issue on GitHub.

Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.

Contributing

This project was made with ❤️. The simplest way to give back is by starring and sharing it online.

If the documentation is unclear or has a typo, please click on the page's Edit button (pencil icon) and suggest a correction.

If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!