good-try
good-try copied to clipboard
Tries to execute a sync/async function, returns a specified default value if the function throws
good-try
Tries to execute a sync/async function, returns a specified default value if the function throws.
Why
Why not nice-try with it's 70+ million downloads per month?
good-trysupports async functions.good-trysupports an optional default value.good-tryallows you to capture the thrown error.good-tryis written in TypeScript. The types are written in a way that reduce developer errors. For example, I sometimes incorrectly typegoodTry(readFileSync()), but the types don't allow this.good-tryhas a friend —settle-it.- I aim for high-quality with my open-source principles.
Why not just try/catch?
- In a lot of cases,
try/catchis still the better option. - Nested
try/catchstatements are hard to process mentally. They also indent the code and make it hard to read. A singletry/catchdoes the same but to a lesser degree. - If you prefer const,
try/catchstatements get in the way because you need to useletif you need the variable outside of thetry/catchscope:let todos; try { todos = JSON.parse(localStorage.getItem('todos')) } catch {} return todos.filter(todo => todo.done) - It takes more space. It's slower to type.
Install
npm install good-try
Usage
import goodTry from 'good-try'
// tries to parse todos, returns empty array if it fails
const value = goodTry(() => JSON.parse(todos), [])
// fetch todos, on error, fallback to empty array
const todos = await goodTry(fetchTodos(), [])
// fetch todos, fallback to empty array, send error to your error tracking service
const todos = await goodTry(fetchTodos(), (err) => {
sentToErrorTrackingService(err)
return []
})
API
First parameter accepts:
- synchronous function
goodTry(() => JSON.parse(value)) - asynchronous function / Promise
- synchronous function that returns a promise
Second parameter accepts:
- any value that will be returned if the first parameter throws
- a callback that receives
erras first parameter (the return value of the callback is returned if the first parameter throws)
If you use TypeScript, the types are well defined and won't let you make a mistake.
Related
- settle-it – Like
Promise.allSettled()but for sync and async functions. Similarly togood-tryit handles sync/async functions that throw an error. However, it returns an object so you know if and what error was thrown.