Skip to content

musicq/panicit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

panicit

npm package

panicit is a small library that could let you exit or throw error with helpful messages. It works in both browser and Node.js.

Getting start

npm i panicit

Usage

import { panic } from 'panicit'

panic('some error')

It will print

some reason
Uncaught Error: some reason
    at n (<anonymous>:2:57)
    at <anonymous>:1:1

with cause

You can provide the cause as well.

import { panic } from 'panicit'

panic('some error', { cause: 'some cause' })

It will print

some reason
[Cause] some cause
Error: some reason
    at n (<anonymous>:2:57)
    at <anonymous>:1:1

If you are using Node.js, you can also provide exit code.

import { panic } from 'panicit'

panic('some error', { cause: 'some cause', exitCode: 2 })

Result

➜ node
> panic('some reason', {cause: 'some cause', exitCode: 2})
some reason
[Cause] some cause

➜ echo $?
2

Prevent exit

By default, panic will exit the program in Node.js, but you can set exit option to false to disable this behavior.

panic('some error', { exit: false })

Note that exit program can only be used in Node environment.

Alias name shouldExit has been deprecated.

Default exit behavior

You can define whether should the program exit by default or not by using setShouldExitByDefault.

import { setShouldExitByDefault } from 'panicit'

setShouldExitByDefault(false)

// this won't exit the program
panic('some error')

// you can still exit the program by set `exit` to `true` explicitly
panic('some error', { exit: true })

About

panicit is a small library that let you exit or throw error with helpful messages.

Resources

License

Stars

Watchers

Forks

Packages

No packages published