result-tsk - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

CHANGELOG.md

@@ -54,3 +54,3 @@ # Changelog
 - NPM package dependencies updated.
-- statusCode now support string type.
+- StatusCode now support string type.
 
@@ -63,1 +63,13 @@ ## [1.1.0] — 2021-01-10
 - Packages was updated
+
+## [1.2.0] — 2021-01-24
+
+### Updated
+
+- SetData function now support optional message parameter
+
+## [1.2.1] — 2021-04-21
+
+### Updated
+
+- Param for trace object was added

demo/runkitExample.js

@@ -9,3 +9,3 @@ const result_tsk = require("result-tsk");
   }
-  Person.prototype.IsAnAdult = function () {
+  Person.prototype.isAnAdult = function () {
     return this.age >= 18 ? true : false;
@@ -19,24 +19,24 @@ };
 const resultSuccess = new result_tsk.Result();
-resultSuccess.SetMessage("Your success message", 200);
+resultSuccess.setMessage("Your success message", 200);
 
 const resultTSuccess = new result_tsk.ResultT();
-resultTSuccess.SetData(person, 201);
+resultTSuccess.setData(person, 201);
 
 const resultNotSuccess = new result_tsk.Result();
-resultNotSuccess.SetError("Your error message", 400);
+resultNotSuccess.setError("Your error message", 400);
 
 const resultTNotSuccess = new result_tsk.ResultT();
-resultTNotSuccess.SetError("Your error message", 400);
+resultTNotSuccess.setError("Your error message", 400);
 
 console.log("Result Success", resultSuccess);
 console.log("ResultT Success", resultTSuccess);
-console.log("Result Success calling to ToResultDto", resultSuccess.ToResultDto());
-console.log("ResultT Success calling to ToResultDto", resultTSuccess.ToResultDto());
+console.log("Result Success calling to ToResultDto", resultSuccess.toResultDto());
+console.log("ResultT Success calling to ToResultDto", resultTSuccess.toResultDto());
 
 console.log("Result Not Success", resultNotSuccess);
 console.log("ResultT Not Success", resultTNotSuccess);
-console.log("Result Not Success calling to ToResultDto", resultNotSuccess.ToResultDto());
+console.log("Result Not Success calling to ToResultDto", resultNotSuccess.toResultDto());
 console.log(
   "ResultT Not Success calling to ToResultDto",
-  resultTNotSuccess.ToResultDto(),
+  resultTNotSuccess.toResultDto(),
 );

lib/generic/Result.d.ts

 import { IResult } from "./Result.interface";
 import { ResultDto } from "../ResultDto";
 export declare class Result<T> implements IResult<T> {
+    #private;
     data: T | string;
@@ -13,3 +14,5 @@ statusCode: number | string;
     SetData(data: string | T, statusCode: number | string, message?: string): void;
+    SetTrace(trace: unknown): void;
+    GetTrace<R>(): R;
     ToResultDto(): ResultDto;
 }

lib/generic/Result.interface.d.ts

@@ -7,3 +7,5 @@ import { IBaseResult } from "../Result.interface";
     SetData(data: T | string, statusCode: number | string, message: string): void;
+    GetTrace<R>(): R;
     ToResultDto(): ResultDto;
+    ToResultDto(): ResultDto;
 }

lib/generic/Result.js

 "use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _trace;
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -6,2 +20,6 @@ exports.Result = void 0;
 class Result {
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        _trace.set(this, void 0);
+    }
     SetStatusCode(statusCode, success) {
@@ -20,2 +38,3 @@ this.statusCode = statusCode;
         this.success = false;
+        __classPrivateFieldSet(this, _trace, JSON.stringify({ error, statusCode }));
     }
@@ -30,2 +49,8 @@ SetData(data, statusCode, message) {
     }
+    SetTrace(trace) {
+        __classPrivateFieldSet(this, _trace, trace);
+    }
+    GetTrace() {
+        return __classPrivateFieldGet(this, _trace);
+    }
     ToResultDto() {
@@ -40,1 +65,2 @@ const result = new ResultDto_1.ResultDto();
 exports.Result = Result;
+_trace = new WeakMap();

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResultT = exports.Result = void 0;
 var Result_1 = require("./Result");
@@ -4,0 +5,0 @@ Object.defineProperty(exports, "Result", { enumerable: true, get: function () { return Result_1.Result; } });

lib/Result.d.ts

 import { IResult } from "./Result.interface";
 import { ResultDto } from "./ResultDto";
 export declare class Result implements IResult {
+    #private;
     statusCode: number | string;
@@ -11,3 +12,5 @@ success: boolean;
     SetError(error: string, statusCode: number | string): void;
+    SetTrace(trace: unknown): void;
+    GetTrace<R>(): R;
     ToResultDto(): ResultDto;
 }

lib/Result.interface.d.ts

@@ -10,4 +10,6 @@ import { ResultDto } from "./ResultDto";
     SetError(error: string, statusCode: number | string): void;
+    SetTrace(trace: unknown): void;
+    GetTrace<R>(): R;
     ToResultDto(): ResultDto;
 }
 export declare type IBaseResult = Omit<IResult, "ToResultDto">;

lib/Result.js

 "use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to set private field on non-instance");
+    }
+    privateMap.set(receiver, value);
+    return value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
+    if (!privateMap.has(receiver)) {
+        throw new TypeError("attempted to get private field on non-instance");
+    }
+    return privateMap.get(receiver);
+};
+var _trace;
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -6,2 +20,6 @@ exports.Result = void 0;
 class Result {
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        _trace.set(this, void 0);
+    }
     SetStatusCode(statusCode, success) {
@@ -20,3 +38,10 @@ this.statusCode = statusCode;
         this.success = false;
+        __classPrivateFieldSet(this, _trace, JSON.stringify({ error, statusCode }));
     }
+    SetTrace(trace) {
+        __classPrivateFieldSet(this, _trace, trace);
+    }
+    GetTrace() {
+        return __classPrivateFieldGet(this, _trace);
+    }
     ToResultDto() {
@@ -30,1 +55,2 @@ const result = new ResultDto_1.ResultDto();
 exports.Result = Result;
+_trace = new WeakMap();

lib/ResultDto.d.ts

 export declare class ResultDto {
     message: string;
     error: string;
-    data: unknown;
+    data: any;
 }

package.json

 {
   "name": "result-tsk",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "result tool for use with or without NodeTskeleton template project",
@@ -34,6 +34,6 @@ "repository": {
   "devDependencies": {
-    "@types/node": "^14.14.20",
-    "typescript": "^3.9.7"
+    "@types/node": "^14.14.31",
+    "typescript": "^4.2.2"
   },
   "dependencies": {}
 }

README.md

@@ -25,10 +25,10 @@ # Result tool 🧰
 		// With the resulting object we can control validations within other functions.
-		if (!this.validator.IsValidEntry(result, { productMaskId: idMask })) {
+		if (!this.validator.isValidEntry(result, { productMaskId: idMask })) {
 			return result;
 		}
-		const product: Product = await this.productQueryService.GetByMaskId(idMask);
+		const product: Product = await this.productQueryService.getByMaskId(idMask);
 		if (!product) {
 			// The result object helps us with the error response and the code.
-			result.SetError(
-				this.resources.Get(this.resourceKeys.PRODUCT_DOES_NOT_EXIST),
+			result.setError(
+				this.resources.get(this.resourceKeys.PRODUCT_DOES_NOT_EXIST),
 				this.resultCodes.NOT_FOUND,
@@ -38,3 +38,3 @@ );
 		}
-		const productDto = this.mapper.MapObject<Product, ProductDto>(product, new ProductDto());
+		const productDto = this.mapper.mapObject<Product, ProductDto>(product, new ProductDto());
 		// The result object also helps you with the response data.
@@ -61,3 +61,3 @@ result.SetData(productDto, this.resultCodes.SUCCESS);
 	itemDto.quantity = null;
-	const result = await addUseCase.Execute(userUid, itemDto);
+	const result = await addUseCase.execute(userUid, itemDto);
 	expect(result.success).toBeFalsy();
@@ -82,3 +82,3 @@ expect(result.error).toBe(
   router: RouterType;
-  HandleResult(res: Response, result: IResult): void {
+  handleResult(res: Response, result: IResult): void {
     if (result.success) {
@@ -97,3 +97,3 @@ res
 	const textDto: TextDto = req.body;
-	this.HandleResult(res, await getLowestFeelingSentenceUseCase.Execute(textDto));
+	this.handleResult(res, await getLowestFeelingSentenceUseCase.execute(textDto));
 /*...*/
@@ -100,0 +100,0 @@ ```

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15671

increased by18.76%

Lines of code

229

increased by37.95%

Worsened metrics

Number of medium maintenance alerts

1

increased byInfinity%

No dependency changes