@consolidados/results 0.1.0

package/dist/types/globals.d.cts

@@ -0,0 +1,64 @@
+import { O as Option, S as Some, N as None } from '../option-DpT8KCGE.cjs';
+import { R as Result, O as Ok, E as Err } from '../err-B7LUEZ0f.cjs';
+
+declare global {
+    function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
+        Ok: (value: T) => R;
+        Err: (error: E) => R;
+    }): R;
+    function match<T, R>(matcher: Option<T>, cases: {
+        Some: (value: T) => R;
+        None: () => R;
+    }): R;
+    function match<T, E extends Error>(matcher: Result<T, E>, cases: {
+        Ok: (value: T) => Option<T>;
+        Err: (error: E) => Option<T>;
+    }): Option<T>;
+    function match<T, E extends Error = Error>(matcher: Option<T>, cases: {
+        Some: (value: T) => Result<T, E>;
+        None: () => Result<T, E>;
+    }): Result<T, E>;
+    /**
+     * Creates a new `Ok` instance, representing a successful result.
+     * @template T The type of the value contained in the `Ok`.
+     * @param value The value to wrap in the `Ok` instance.
+     * @returns An `Ok` instance containing the given value.
+     * @example
+     * const result = Ok(42);
+     * console.log(result.isOk()); // true
+     * console.log(result.unwrap()); // 42
+     */
+    function Ok<T>(value: T): Ok<T>;
+    /**
+     * Creates a new `Err` instance, representing a failed result.
+     * @template E The type of the error contained in the `Err`.
+     * @param error The error to wrap in the `Err` instance.
+     * @returns An `Err` instance containing the given error.
+     * @example
+     * const result = Err("Something went wrong");
+     * console.log(result.isErr()); // true
+     * console.log(result.unwrapErr()); // "Something went wrong"
+     */
+    function Err<E extends Error>(error: E | string): Err<E>;
+    /**
+     * creates a new `Some` instance, representing some value.
+     * @template T the type of the value contained in the `Some`.
+     * @param value the value to wrap in the `some` instance.
+     * @returns an `Some` instance containing the given value.
+     * @example
+     * const option = Some("some value");
+     * console.log(option.isSome()); // true
+     * console.log(option.unwrap()); // "some value"
+     */
+    function Some<T>(value: T): Some<T>;
+    /**
+     * creates a new `None` instance, representing no value.
+     * @param  `` There are no paramaters in the `None` instance.
+     * @returns an `None` instance containing no value.
+     * @example
+     * const option = None();
+     * console.log(option.isNone()); // true
+     * console.log(option.unwrap()); // throws
+     */
+    function None(): None;
+}

package/dist/types/globals.d.ts

@@ -0,0 +1,64 @@
+import { O as Option, S as Some, N as None } from '../option-DpT8KCGE.js';
+import { R as Result, O as Ok, E as Err } from '../err-B7LUEZ0f.js';
+
+declare global {
+    function match<T, E extends Error, R>(matcher: Result<T, E>, cases: {
+        Ok: (value: T) => R;
+        Err: (error: E) => R;
+    }): R;
+    function match<T, R>(matcher: Option<T>, cases: {
+        Some: (value: T) => R;
+        None: () => R;
+    }): R;
+    function match<T, E extends Error>(matcher: Result<T, E>, cases: {
+        Ok: (value: T) => Option<T>;
+        Err: (error: E) => Option<T>;
+    }): Option<T>;
+    function match<T, E extends Error = Error>(matcher: Option<T>, cases: {
+        Some: (value: T) => Result<T, E>;
+        None: () => Result<T, E>;
+    }): Result<T, E>;
+    /**
+     * Creates a new `Ok` instance, representing a successful result.
+     * @template T The type of the value contained in the `Ok`.
+     * @param value The value to wrap in the `Ok` instance.
+     * @returns An `Ok` instance containing the given value.
+     * @example
+     * const result = Ok(42);
+     * console.log(result.isOk()); // true
+     * console.log(result.unwrap()); // 42
+     */
+    function Ok<T>(value: T): Ok<T>;
+    /**
+     * Creates a new `Err` instance, representing a failed result.
+     * @template E The type of the error contained in the `Err`.
+     * @param error The error to wrap in the `Err` instance.
+     * @returns An `Err` instance containing the given error.
+     * @example
+     * const result = Err("Something went wrong");
+     * console.log(result.isErr()); // true
+     * console.log(result.unwrapErr()); // "Something went wrong"
+     */
+    function Err<E extends Error>(error: E | string): Err<E>;
+    /**
+     * creates a new `Some` instance, representing some value.
+     * @template T the type of the value contained in the `Some`.
+     * @param value the value to wrap in the `some` instance.
+     * @returns an `Some` instance containing the given value.
+     * @example
+     * const option = Some("some value");
+     * console.log(option.isSome()); // true
+     * console.log(option.unwrap()); // "some value"
+     */
+    function Some<T>(value: T): Some<T>;
+    /**
+     * creates a new `None` instance, representing no value.
+     * @param  `` There are no paramaters in the `None` instance.
+     * @returns an `None` instance containing no value.
+     * @example
+     * const option = None();
+     * console.log(option.isNone()); // true
+     * console.log(option.unwrap()); // throws
+     */
+    function None(): None;
+}

package/dist/types/globals.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=globals.js.map
+//# sourceMappingURL=globals.js.map

package/dist/types/globals.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"globals.js"}

package/index.ts

@@ -0,0 +1,3 @@
+export * from "./src/helpers/match";
+export * from "./src/option";
+export * from "./src/result";

package/package.json

@@ -0,0 +1,66 @@
+{
+	"name": "@consolidados/results",
+	"version": "0.1.0",
+	"description": "Result types, ease and simple",
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"homepage": "https://github.com/consolidados/results",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/consolidados/results"
+	},
+	"exports": {
+		"./option": {
+			"types": "./dist/option/index.d.ts",
+			"require": "./dist/option/index.cjs",
+			"default": "./dist/option/index.js"
+		},
+		"./result": {
+			"types": "./dist/result/index.d.ts",
+			"require": "./dist/result/index.cjs",
+			"default": "./dist/result/index.js"
+		},
+		"./helpers": {
+			"types": "./dist/helpers/match.d.ts",
+			"require": "./dist/helpers/match.cjs",
+			"default": "./dist/helpers/match.js"
+		},
+		"./globals": {
+			"types": "./dist/types/globals.d.ts"
+		},
+		".": {
+			"types": "./dist/index.d.ts",
+			"require": "./dist/index.cjs",
+			"default": "./dist/index.js"
+		}
+	},
+	"scripts": {
+		"build": "rm -rf dist && tsup",
+		"test": "vitest run",
+		"release": "release-it"
+	},
+	"keywords": [
+		"Rust",
+		"Result",
+		"Option",
+		"Some",
+		"None",
+		"Ok",
+		"Err",
+		"Match"
+	],
+	"author": "Johnny Carreiro",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/node": "^22.13.13",
+		"release-it": "^18.1.2",
+		"tsup": "^8.4.0",
+		"typescript": "^5.8.2",
+		"vitest": "^3.0.9"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

package/vite.config.ts

@@ -0,0 +1,16 @@
+/// <reference types="vitest" />
+import { defineConfig } from "vitest/config";
+import path from "path";
+
+export default defineConfig({
+	resolve: {
+		alias: {
+			"@": path.resolve(__dirname, "./src"),
+		},
+	},
+	plugins: [],
+	test: {
+		globals: true,
+		setupFiles: "./test/setup-tests.ts",
+	},
+});