smart-result 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,2 @@
+#### 0.0.1 (2024-03-27)
+

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 misuken
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,153 @@
+# smart-result
+
+This type library is a very smart result type available in TypeScript 4.6 or later.
+
+```
+import type { Reulst } from "smart-result";
+
+async function loadData(): Promise<Result<Data, Error>> {
+    try {
+        const response = await client.get();
+        return { ok: response.data };
+    } catch (error) {
+        if (error instanceof Error) {
+            return { error: error };
+        }
+        return { error: new Error("unknown error") };
+    }
+}
+
+
+async function example() {
+    const { ok: data, error } = await loadData();
+    if (data) {
+        console.log(data); // data: Data; error: undefined;
+    } else {
+        console.error(error); // data: undefined; error: Error;
+    }
+}
+```
+
+## Highlight
+
+🖊 Good coding quality
+👀 Highly readable
+😄 Fewer things to remember
+✅ Safety design
+🛡 Type only
+
+## Intall
+
+```
+npm install -D `smart-result`
+```
+
+or
+
+```
+yarn add -D `smart-result`
+```
+
+## Usage
+
+### Void Pattern
+
+```
+import type { Reulst } from "smart-result";
+
+async function start(): Promise<Result<true, Error>> {
+    try {
+        await client.start();
+        return { ok: true };
+    } catch (error) {
+        if (error instanceof Error) {
+            return { error: error };
+        }
+        return { error: new Error("unknown error") };
+    }
+}
+
+async function example() {
+    // Use "ok" if you only want to know if you succeeded or not
+    const { ok, error } = await start();
+    if (ok) {
+        console.log(ok); // ok: true;
+    } else {
+        console.error(error); // ok: undefined; error: Error;
+    }
+}
+```
+
+### Return Data Pattern
+
+```
+import type { Reulst } from "smart-result";
+
+async function loadData(): Promise<Result<Data, Error>> {
+    try {
+        const response = await client.get();
+        return { ok: response.data };
+    } catch (error) {
+        if (error instanceof Error) {
+            return { error: error };
+        }
+        return { error: new Error("unknown error") };
+    }
+}
+
+async function example() {
+    // Assign a name to "ok" if you want to handle the resulting information
+    const { ok: data, error } = await loadData();
+    if (data) {
+        console.log(data); // data: Data; error: undefined;
+    } else {
+        console.error(error); // data: undefined; error: Error;
+    }
+}
+```
+
+### Return Value Pattern
+
+```
+import type { Reulst } from "smart-result";
+
+async function loadValue(): Promise<Result<{ value: number }, Error>> {
+    try {
+        const response = await client.get();
+        // If you want to return a primitive value, wrap it with `{ value: }`.
+        return { ok: { value: response.data } };
+    } catch (error) {
+        if (error instanceof Error) {
+            return { error: error };
+        }
+        return { error: new Error("unknown error") };
+    }
+}
+
+async function example() {
+    const { ok, error } = await loadValue();
+    if (ok) {
+        console.log(ok.value); // ok: { value: number } error: undefined;
+    } else {
+        console.error(error); // data: undefined; error: Error;
+    }
+}
+```
+
+## API
+
+### `Result<Data extends true | Record<string, any>, Error>`
+
+Alias for `OkResult<Data> | ErrorResult<Error>`.
+
+### `OkResult<Data extends true | Record<string, any>>`
+
+An object with the key `ok` and without the key `error`.
+
+### `ErrorResult<Error extends Record<string, any>>>`
+
+An object with the key `error` and without the key `ok`.
+
+## LICENSE
+
+[@misuken-now/smart-result](https://github.com/misuken-now/smart-result)・MIT

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "smart-result",
+  "version": "0.0.1",
+  "description": "",
+  "scripts": {
+    "build": "yarn clean && tsc -p ./tsconfig.json",
+    "clean": "del-cli lib module",
+    "versionup:major": "changelog -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major",
+    "versionup:minor": "changelog -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor",
+    "versionup:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/misuken-now/smart-result.git"
+  },
+  "keywords": [],
+  "author": "misuken-now (https://github.com/misuken-now)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/misuken-now/smart-result/issues"
+  },
+  "homepage": "https://github.com/misuken-now/smart-result#readme",
+  "main": "./lib/index.js",
+  "typings": "./lib/index.d.ts",
+  "devDependencies": {
+    "generate-changelog": "^1.8.0",
+    "del-cli": "^4.0.1",
+    "typescript": "^5.4.3"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.6.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,60 @@
+/**
+ * Type of the result in case of success.
+ *
+ * If a string or number is specified directly for ok, it will be judged false if an empty string or 0 is specified, so only true or Record<string, any> can be specified.
+ */
+export type OkResult<Data extends true | Record<string, any>> = {
+    readonly error?: never;
+    // If the result is `{}`, set it to `Record<string, unknown>` to make type resolution work as expected when the result branches.
+    readonly ok: [keyof Data] extends [never] ? Record<string, unknown> : Data;
+};
+
+/**
+ * Type of the result in case of error.
+ */
+export type ErrorResult<Error extends Record<string, any>> = { readonly error: Error; readonly ok?: never };
+
+/**
+ * Object type for easier handling of results.
+ *
+ * @example If you do not need to return the results.
+ *  async function foo(): Promise<Result<true, Error>> {
+ *    try {
+ *      await bar();
+ *      return { ok: true };
+ *    } catch (error) {
+ *      if (error instanceof Error) {
+ *        return { error };
+ *      }
+ *      return { error: new Error("unknown error") };
+ *    }
+ *  }
+ *
+ *  const { ok, error } = await foo();
+ *  if (ok) {
+ *    console.log(ok); // ok: true; error: undefined;
+ *  } else {
+ *    console.error(error); // ok: undefined; error: Error;
+ *  }
+ *
+ * @example If you do need to return the results.
+ *  async function foo(): Promise<Result<Data, Error>> {
+ *    try {
+ *      const response = await bar();
+ *      return { ok: response.data };
+ *    } catch (error) {
+ *      if (error instanceof Error) {
+ *        return { error };
+ *      }
+ *      return { error: new Error("unknown error") };
+ *    }
+ *  }
+ *
+ *  const { ok: data, error } = await foo();
+ *  if (data) {
+ *    console.log(data); // data: Data; error: undefined;
+ *  } else {
+ *    console.error(error); // data: undefined; error: Error;
+ *  }
+ */
+export type Result<Data extends true | Record<string, any>, Error extends Record<string, any>> = OkResult<Data> | ErrorResult<Error>;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+      "target": "esnext",
+      "module": "esnext",
+      "declaration": true,
+      "outDir": "./lib",
+      "esModuleInterop": true,
+      "forceConsistentCasingInFileNames": true,
+      "strict": true,
+      "skipLibCheck": true
+    },
+    "include": ["src/**/*.ts"],
+    "exclude": ["node_modules"]
+  }