Replace rusty-result-ts with neverthrow package (#7)

+ Bump version to 0.3.0 Submitted by @corners2wall
Xkonti · Sep 7, 2023 · a1f3f3b · a1f3f3b
1 parent 5133448
commit a1f3f3b
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 23 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "axios-service-base-ts",
   "private": false,
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "A base class for API services using Axios",
   "homepage": "https://github.com/Xkonti/axios-service-base-ts#readme",
   "repository": {
@@ -42,7 +42,7 @@
   "dependencies": {
     "axios": "^1.4.0",
     "lodash-es": "^4.17.21",
-    "rusty-result-ts": "^0.1.0"
+    "neverthrow": "^6.0.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/api-service-base.ts b/src/api-service-base.ts
@@ -1,6 +1,6 @@
 import axios, { AxiosRequestConfig } from 'axios';
 import { merge } from 'lodash-es';
-import { err, ok, Result } from 'rusty-result-ts';
+import { err, ok, Result } from 'neverthrow';
 
 import { ApiError } from './api-error';
 
@@ -36,7 +36,7 @@ export class ApiServiceBase {
   protected async get<T> (
     path = '',
     configOverrides: AxiosRequestConfig | undefined = undefined,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     return await this.requestResultWrapper<T>(path, configOverrides, (fullPath, config) => {
       return axios.get(fullPath, config);
     });
@@ -53,7 +53,7 @@ export class ApiServiceBase {
     path = '',
     data: unknown = undefined,
     configOverrides: AxiosRequestConfig | undefined = undefined,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     return await this.requestResultWrapper<T>(path, configOverrides, (fullPath, config) => {
       return axios.post(fullPath, data, config);
     });
@@ -70,7 +70,7 @@ export class ApiServiceBase {
     path = '',
     data: unknown = undefined,
     configOverrides: AxiosRequestConfig | undefined = undefined,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     return await this.requestResultWrapper<T>(path, configOverrides, (fullPath, config) => {
       return axios.put(fullPath, data, config);
     });
@@ -87,7 +87,7 @@ export class ApiServiceBase {
     path = '',
     data: unknown = undefined,
     configOverrides: AxiosRequestConfig | undefined = undefined,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     return await this.requestResultWrapper<T>(path, configOverrides, (fullPath, config) => {
       return axios.patch(fullPath, data, config);
     });
@@ -102,7 +102,7 @@ export class ApiServiceBase {
   protected async delete<T> (
     path = '',
     configOverrides: AxiosRequestConfig | undefined = undefined,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     return await this.requestResultWrapper<T>(path, configOverrides, (fullPath, config) => {
       return axios.delete(fullPath, config);
     });
@@ -112,13 +112,13 @@ export class ApiServiceBase {
     subPath: string,
     configOverrides: AxiosRequestConfig | undefined,
     request: (fullPath: string, config: AxiosRequestConfig | undefined) => Promise<{data: unknown} | null>,
-  ): Promise<Result<T | null, ApiError>> {
+  ): Promise<Result<T, ApiError>> {
     if (subPath.length > 0 && subPath[0] !== '/') subPath = `/${subPath}`;
     const config = merge(this.getConfig() || {}, configOverrides || {});
     try {
-      const responseData: T | null = (await request(`${this.urlBase}${subPath}`, config))?.data as T ?? null;
+      const responseData: T = (await request(`${this.urlBase}${subPath}`, config))?.data as T;
       return ok(responseData);
-    } catch (e: unknown) {
+    } catch (e) {
       return err(new ApiError(e));
     }
   }

diff --git a/src/api-service.test.ts b/src/api-service.test.ts
@@ -1,13 +1,13 @@
 import { test, expect, beforeEach, afterEach, assert } from 'vitest';
 import express from 'express';
 import {ApiError} from './api-error.ts';
-import {Result} from 'rusty-result-ts';
+import {Result} from 'neverthrow';
 import {ApiServiceBase} from './api-service-base.ts';
 
 const port = 3167;
 const helloMessage = 'Hello there!';
 
-let server: ReturnType<typeof startApiServer> | null;
+let server: ReturnType<typeof startApiServer>;
 
 function startApiServer() {
   const app = express();
@@ -39,11 +39,11 @@ class TestService extends ApiServiceBase {
     super(`http://localhost:${port}/api`);
   }
 
-  public async getHello(): Promise<Result<string | null, ApiError>> {
+  public async getHello(): Promise<Result<string, ApiError>> {
     return await this.get('/hello');
   }
 
-  public async getNothing(): Promise<Result<string | null, ApiError>> {
+  public async getNothing(): Promise<Result<string, ApiError>> {
     return await this.get('/nothing');
   }
 }
@@ -52,7 +52,7 @@ test('should make a GET request', async () => {
   const service = new TestService();
   const result = await service.getHello();
 
-  assert(result.isOk());
+  assert(result.isOk()); 
   expect(result.value).toBe(helloMessage);
 });