biome.json

@@ -4,18 +4,19 @@
     "ignore": [
       "node_modules/**",
       "dist/**",
-      "coverage/**"
+      "coverage/**",
+      "src/resultx.ts"
     ]
   },
   "formatter": {
     "enabled": true,
+    "ignore": [
+      "src/shuutils.ts"
+    ],
     "indentStyle": "space",
     "indentWidth": 2,
     "lineEnding": "lf",
-    "lineWidth": 180,
-    "ignore": [
-      "src/shuutils.ts"
-    ]
+    "lineWidth": 180
   },
   "javascript": {
     "formatter": {
@@ -77,4 +78,4 @@
       }
     }
   ]
-}
+}

eslint.config.js

@@ -1,6 +1,13 @@
 import shuunen from 'eslint-plugin-shuunen'
 
 /** @type {import('eslint').Linter.Config[]} */
-const config = [...shuunen.configs.base, ...shuunen.configs.typescript]
+const config = [
+  ...shuunen.configs.base,
+  ...shuunen.configs.typescript,
+  {
+    ignores: ['src/resultx.ts'],
+    name: 'shuutils-ignores',
+  },
+]
 
 export default config

package.json

@@ -6,7 +6,6 @@
   },
   "bugs": "https://github.com/Shuunen/shuutils/issues",
   "dependencies": {
-    "resultx": "2.0",
     "tiny-glob": "0.2"
   },
   "description": "utils collection",
@@ -76,5 +75,5 @@
   },
   "type": "module",
   "types": "./dist/shuutils.d.ts",
-  "version": "10.4.0"
+  "version": "10.5.0"
 }

src/result.test.ts

@@ -1,7 +1,7 @@
 import { expect, it } from 'vitest'
 import { Result } from './result'
 
-it('result.ok', () => {
+it('Result.ok', () => {
   expect(Result.ok(42)).toMatchInlineSnapshot(`
     Ok {
       "ok": true,
@@ -10,11 +10,61 @@ it('result.ok', () => {
   `)
 })
 
-it('result.error', () => {
+it('Result.error', () => {
   expect(Result.error('ay ay ay caramba !')).toMatchInlineSnapshot(`
     Err {
       "error": "ay ay ay caramba !",
       "ok": false,
     }
   `)
 })
+
+it('Result.trySafe A ok', () => {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  const result = Result.trySafe(() => JSON.parse('{"a": 42}'))
+  expect(result).toMatchInlineSnapshot(`
+    Ok {
+      "ok": true,
+      "value": {
+        "a": 42,
+      },
+    }
+  `)
+})
+
+it('Result.trySafe B error', () => {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  const result = Result.trySafe(() => JSON.parse('{"a": 42'))
+  expect(result).toMatchInlineSnapshot(`
+    Err {
+      "error": [SyntaxError: Expected ',' or '}' after property value in JSON at position 8 (line 1 column 9)],
+      "ok": false,
+    }
+  `)
+})
+
+it('Result.trySafe C promise ok', async () => {
+  const result = await Result.trySafe(Promise.resolve(42))
+  expect(result).toMatchInlineSnapshot(`
+    Ok {
+      "ok": true,
+      "value": 42,
+    }
+  `)
+})
+
+it('Result.unwrap A ok', () => {
+  const result = Result.trySafe(() => ({ ahh: 42 }))
+  const { error, value } = Result.unwrap(result)
+  expect(value?.ahh).toMatchInlineSnapshot(`42`)
+  expect(error).toMatchInlineSnapshot(`undefined`)
+})
+
+it('Result.unwrap B error', () => {
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+  const result = Result.trySafe(() => JSON.parse('{"a": 42'))
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const { error, value } = Result.unwrap(result)
+  expect(value).toMatchInlineSnapshot(`undefined`)
+  expect(error).toMatchInlineSnapshot(`[SyntaxError: Expected ',' or '}' after property value in JSON at position 8 (line 1 column 9)]`)
+})

src/result.ts

@@ -1,7 +1,7 @@
-import { err, ok, trySafe, unwrap } from 'resultx'
+import { err as error, ok, trySafe, unwrap } from './resultx'
 
 /**
- * A `Result` collection of functions to handle errors and successes.
+ * A `Result` collection of functions from Johann Schopplich to handle errors and successes.
  * @see https://github.com/johannschopplich/resultx
  * @see https://github.com/Shuunen/ts-result-comparison
  */
@@ -11,7 +11,7 @@ export const Result = {
    * Create a failing `Result` with an error message.
    * @example if (shitHappen) return Result.error('File not found')
    */
-  error: err,
+  error,
   /**
    * Create a successful `Result` with a value.
    * @example return Result.ok(42)

src/resultx.ts

@@ -0,0 +1,60 @@
+// MIT License Copyright (c) 2023-PRESENT Johann Schopplich
+// I had to get sources from https://github.com/johannschopplich/resultx/blob/main/src/index.ts to be able to have a cjs working version of the library
+
+type Result<T, E> = Ok<T> | Err<E>
+
+interface UnwrappedOk<T> { value: T, error: undefined }
+interface UnwrappedErr<E> { value: undefined, error: E }
+type UnwrappedResult<T, E> = UnwrappedOk<T> | UnwrappedErr<E>
+
+class Ok<T> {
+  readonly value: T
+  readonly ok = true
+  constructor(value: T) {
+    this.value = value
+  }
+}
+
+class Err<E> {
+  readonly error: E
+  readonly ok = false
+  constructor(error: E) {
+    this.error = error
+  }
+}
+
+export function ok<T>(value: T): Ok<T> {
+  return new Ok(value)
+}
+
+export function err<E extends string = string>(error: E): Err<E>
+export function err<E = unknown>(error: E): Err<E>
+export function err<E = unknown>(error: E): Err<E> {
+  return new Err(error)
+}
+
+export function trySafe<T, E = unknown>(fn: () => T): Result<T, E>
+export function trySafe<T, E = unknown>(promise: Promise<T>): Promise<Result<T, E>>
+export function trySafe<T, E = unknown>(
+  fnOrPromise: (() => T) | Promise<T>,
+): Result<T, E> | Promise<Result<T, E>> {
+  if (fnOrPromise instanceof Promise) {
+    return fnOrPromise.then(ok).catch((err as (error: unknown) => Err<E>))
+  }
+
+  try {
+    return ok(fnOrPromise())
+  }
+  catch (error) {
+    return err(error as E)
+  }
+}
+
+export function unwrap<T>(result: Ok<T>): UnwrappedOk<T>
+export function unwrap<E>(result: Err<E>): UnwrappedErr<E>
+export function unwrap<T, E>(result: Result<T, E>): UnwrappedResult<T, E>
+export function unwrap<T, E>(result: Result<T, E>): UnwrappedResult<T, E> {
+  return result.ok
+    ? { value: result.value, error: undefined }
+    : { value: undefined, error: result.error }
+}

src/shuutils.ts

@@ -36,6 +36,7 @@ export * from './object-sort'
 export * from './objects'
 export * from './random'
 export * from './result'
+export * from './resultx'
 export * from './state'
 export * from './storage'
 export * from './string-case'