go-go-try 1.0.0 → 2.0.2

package/README.md

@@ -1,6 +1,6 @@
 # `go-go-try`
 
-> Tries to execute a sync/async function, returns a specified default value if the function throws.
+> Tries to execute a sync/async function, returns a Golang style result.
 
 [![Gzipped Size](https://img.shields.io/bundlephobia/minzip/good-try)](https://bundlephobia.com/result?p=good-try)
 [![Build Status](https://img.shields.io/github/workflow/status/astoilkov/good-try/CI)](https://github.com/astoilkov/good-try/actions/workflows/main.yml)
@@ -10,7 +10,6 @@
 Why not [`nice-try`](https://github.com/electerious/nice-try) with it's 70+ million downloads per month?
 
 -   `go-go-try` supports async functions.
--   `go-go-try` supports an optional default value.
 -   `go-go-try` allows you to capture the thrown error.
 -   `go-go-try` is written in TypeScript. The types are written in a way that reduce developer errors.
 -   `go-go-try` is inspired by Golang error catching.
@@ -41,13 +40,13 @@ npm install go-go-try
 import goTry from 'go-go-try'
 
 // tries to parse todos, returns empty array if it fails
-const [_, value] = goTry(() => JSON.parse(todos), [])
+const [_, value = []] = goTry(() => JSON.parse(todos))
 
 // fetch todos, on error, fallback to empty array
-const [_, todos] = await goTry(fetchTodos(), [])
+const [_, todos = []] = await goTry(fetchTodos())
 
 // fetch todos, fallback to empty array, send error to your error tracking service
-const [err, todos] = await goTry(fetchTodos(), [])
+const [err, todos = []] = await goTry(fetchTodos())
 sentToErrorTrackingService(err)
 ```
 
@@ -58,11 +57,8 @@ sentToErrorTrackingService(err)
 -   synchronous function `goTry(() => JSON.parse(value))`
 -   asynchronous function / Promise
 
-**Second parameter** accepts:
-
--   a value of the same type of the first parameter that will be returned if the first parameter throws
-
 **Returns** a tuple with the possible error and result (Golang style)
+
 If you use TypeScript, the types are well defined and won't let you make a mistake.
 
 ## Inspiration

package/index.d.ts

@@ -1,4 +1,3 @@
-declare type ResultTuple<T> = [string?, T?];
-export default function goTry<T>(value: Promise<T>, defaultValue?: T): Promise<ResultTuple<T>>;
-export default function goTry<T>(value: () => T, defaultValue?: T): ResultTuple<T>;
+declare type ResultTuple<T> = [string, undefined] | [undefined, T];
+export default function goTry<T>(value: (() => T) | PromiseLike<T>): ResultTuple<T> | PromiseLike<ResultTuple<T>>;
 export {};

package/index.js

@@ -21,17 +21,18 @@ function toErrorWithMessage(maybeError) {
 function getErrorMessage(error) {
     return toErrorWithMessage(error).message;
 }
-export default function goTry(value, defaultValue) {
+export default function goTry(value) {
+    let unwrappedValue;
     try {
-        const unwrappedValue = typeof value === 'function' ? value() : value;
+        unwrappedValue = typeof value === 'function' ? value() : value;
         if (pIsPromise(unwrappedValue)) {
             return Promise.resolve(unwrappedValue)
                 .then((value) => [undefined, value])
-                .catch((err) => [getErrorMessage(err), defaultValue]);
+                .catch((err) => [getErrorMessage(err), undefined]);
         }
         return [undefined, unwrappedValue];
     }
     catch (err) {
-        return [getErrorMessage(err), defaultValue];
+        return [getErrorMessage(err), undefined];
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "go-go-try",
-    "version": "1.0.0",
+    "version": "2.0.2",
     "description": "Tries to execute a sync/async function, returns a result tuple",
     "license": "MIT",
     "repository": "thelinuxlich/go-go-try",