- Big update!Introducing GitHub Bot Commands. Learn more →
- Version published
- Maintainers
- 1
- Weekly downloads
- 8,410,404
- increased by7.94%
Weekly downloads
Changelog
2.0.2
- 209421d Add improved types
- 1f7c988 Update docs
- f6640b3 Use strict types
Full Changelog: https://github.com/wooorm/bail/compare/2.0.1...2.0.2
Readme
bail
Throw if given an error.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package throws a given error.
When should I use this?
Use this package if you’re building some scripts that might theoretically get
errors but frequently don’t and you keep writing if (error) throw error over
and over again and you’re just really done with that.
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install bail
In Deno with Skypack:
import {bail} from 'https://cdn.skypack.dev/bail@2?dts'
In browsers with Skypack:
<script type="module">
import {bail} from 'https://cdn.skypack.dev/[email protected]?min'
</script>
Use
import {bail} from 'bail'
bail()
bail(new Error('failure'))
// Error: failure
// at repl:1:6
// at REPLServer.defaultEval (repl.js:154:27)
// …
API
This package exports the following identifier: bail.
There is no default export.
bail(err?)
Throw a given error (Error?).
Types
This package is fully typed with TypeScript. There are no extra exported types.
Compatibility
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
Security
This package is safe.
Related
Contribute
Yes please! See How to Contribute to Open Source.
License
FAQs
What is bail?
Throw a given error
Is bail popular?
The npm package bail receives a total of 8,095,866 weekly downloads. As such, bail popularity was classified as popular.
Is bail well maintained?
We found that bail demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.