retuple 1.0.0-next.12 → 1.0.0-next.14

package/dist/symbol.cjs

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultLikeSymbol = void 0;
+/**
+ * ## Result Like Symbol
+ *
+ * Implement a custom result-like by implementing the `ResultLike` interface
+ * on a class or object. An object with this implementation can be converted
+ * to a `Result` and can be used in most places where a `Result` is required.
+ *
+ * ```ts
+ * import { ResultLikeSymbol } from "retuple/symbol";
+ * import { Result, Ok, Err, type ResultLike } from "retuple";
+ *
+ * class CustomResult<T> implements ResultLike<T, CustomError> {
+ *   value: T;
+ *
+ *   constructor(value: T) {
+ *     this.value = value;
+ *   }
+ *
+ *   [ResultLikeSymbol](): Result<T, CustomError> {
+ *     return this.value === "test"
+ *       ? Ok(this.value)
+ *       : Err(new CustomError("Value was not test"));
+ *   }
+ * }
+ *
+ * const custom = new CustomResult("test");
+ * const result: Result<string, Error> = Result(custom);
+ *
+ * const chain = Ok()
+ *  .$map(() => "value")
+ *  .$andThen((value) => new CustomResult(value))
+ *  .$or(myresult);
+ * ```
+ */
+exports.ResultLikeSymbol = Symbol("retuple/result");

package/dist/symbol.d.cts

@@ -0,0 +1,36 @@
+/**
+ * ## Result Like Symbol
+ *
+ * Implement a custom result-like by implementing the `ResultLike` interface
+ * on a class or object. An object with this implementation can be converted
+ * to a `Result` and can be used in most places where a `Result` is required.
+ *
+ * ```ts
+ * import { ResultLikeSymbol } from "retuple/symbol";
+ * import { Result, Ok, Err, type ResultLike } from "retuple";
+ *
+ * class CustomResult<T> implements ResultLike<T, CustomError> {
+ *   value: T;
+ *
+ *   constructor(value: T) {
+ *     this.value = value;
+ *   }
+ *
+ *   [ResultLikeSymbol](): Result<T, CustomError> {
+ *     return this.value === "test"
+ *       ? Ok(this.value)
+ *       : Err(new CustomError("Value was not test"));
+ *   }
+ * }
+ *
+ * const custom = new CustomResult("test");
+ * const result: Result<string, Error> = Result(custom);
+ *
+ * const chain = Ok()
+ *  .$map(() => "value")
+ *  .$andThen((value) => new CustomResult(value))
+ *  .$or(myresult);
+ * ```
+ */
+export declare const ResultLikeSymbol: unique symbol;
+export type ResultLikeSymbol = typeof ResultLikeSymbol;

package/dist/symbol.d.ts

@@ -0,0 +1,36 @@
+/**
+ * ## Result Like Symbol
+ *
+ * Implement a custom result-like by implementing the `ResultLike` interface
+ * on a class or object. An object with this implementation can be converted
+ * to a `Result` and can be used in most places where a `Result` is required.
+ *
+ * ```ts
+ * import { ResultLikeSymbol } from "retuple/symbol";
+ * import { Result, Ok, Err, type ResultLike } from "retuple";
+ *
+ * class CustomResult<T> implements ResultLike<T, CustomError> {
+ *   value: T;
+ *
+ *   constructor(value: T) {
+ *     this.value = value;
+ *   }
+ *
+ *   [ResultLikeSymbol](): Result<T, CustomError> {
+ *     return this.value === "test"
+ *       ? Ok(this.value)
+ *       : Err(new CustomError("Value was not test"));
+ *   }
+ * }
+ *
+ * const custom = new CustomResult("test");
+ * const result: Result<string, Error> = Result(custom);
+ *
+ * const chain = Ok()
+ *  .$map(() => "value")
+ *  .$andThen((value) => new CustomResult(value))
+ *  .$or(myresult);
+ * ```
+ */
+export declare const ResultLikeSymbol: unique symbol;
+export type ResultLikeSymbol = typeof ResultLikeSymbol;

package/dist/symbol.js

@@ -0,0 +1,35 @@
+/**
+ * ## Result Like Symbol
+ *
+ * Implement a custom result-like by implementing the `ResultLike` interface
+ * on a class or object. An object with this implementation can be converted
+ * to a `Result` and can be used in most places where a `Result` is required.
+ *
+ * ```ts
+ * import { ResultLikeSymbol } from "retuple/symbol";
+ * import { Result, Ok, Err, type ResultLike } from "retuple";
+ *
+ * class CustomResult<T> implements ResultLike<T, CustomError> {
+ *   value: T;
+ *
+ *   constructor(value: T) {
+ *     this.value = value;
+ *   }
+ *
+ *   [ResultLikeSymbol](): Result<T, CustomError> {
+ *     return this.value === "test"
+ *       ? Ok(this.value)
+ *       : Err(new CustomError("Value was not test"));
+ *   }
+ * }
+ *
+ * const custom = new CustomResult("test");
+ * const result: Result<string, Error> = Result(custom);
+ *
+ * const chain = Ok()
+ *  .$map(() => "value")
+ *  .$andThen((value) => new CustomResult(value))
+ *  .$or(myresult);
+ * ```
+ */
+export const ResultLikeSymbol = Symbol("retuple/result");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retuple",
-  "version": "1.0.0-next.12",
+  "version": "1.0.0-next.14",
   "scripts": {
     "test": "vitest",
     "lint": "eslint . --ext .ts -c eslint.config.mjs --fix",
@@ -11,7 +11,12 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.cts",
   "module": "./dist/index.js",
-  "zshy": "./src/index.ts",
+  "zshy": {
+    "exports": {
+      ".": "./src/index.ts",
+      "./symbol": "./src/symbol.ts"
+    }
+  },
   "keywords": [
     "result",
     "safe",
@@ -43,6 +48,11 @@
       "types": "./dist/index.d.cts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./symbol": {
+      "types": "./dist/symbol.d.cts",
+      "import": "./dist/symbol.js",
+      "require": "./dist/symbol.cjs"
     }
   },
   "files": [