result-tsk - npm Package Compare versions

Comparing version 1.2.0 to 2.0.0

CHANGELOG.md

@@ -62,1 +62,15 @@ # Changelog
 - Packages was updated
+
+## [1.2.0] — 2021-01-24
+
+### Updated
+
+- SetData function now support optional message parameter
+
+## [2.0.0] — 2021-02-28
+
+### Updated
+
+- Methods was changed to camelCase.
+- Readme was updated.
+- Packages was updated.

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

@@ -9,7 +9,7 @@ import { IResult } from "./Result.interface";
     error: string;
-    SetStatusCode(statusCode: number | string, success: boolean): void;
-    SetMessage(message: string, statusCode: number | string): void;
-    SetError(error: string, statusCode: number | string): void;
-    SetData(data: string | T, statusCode: number | string, message?: string): void;
-    ToResultDto(): ResultDto;
+    setStatusCode(statusCode: number | string, success: boolean): void;
+    setMessage(message: string, statusCode: number | string): void;
+    setError(error: string, statusCode: number | string): void;
+    setData(data: string | T, statusCode: number | string, message?: string): void;
+    toResultDto(): ResultDto;
 }

lib/generic/Result.interface.d.ts

@@ -5,5 +5,5 @@ import { IBaseResult } from "../Result.interface";
     data: T | string;
-    SetData(data: T | string, statusCode: number | string): void;
-    SetData(data: T | string, statusCode: number | string, message: string): void;
-    ToResultDto(): ResultDto;
+    setData(data: T | string, statusCode: number | string): void;
+    setData(data: T | string, statusCode: number | string, message: string): void;
+    toResultDto(): ResultDto;
 }

lib/generic/Result.js

@@ -6,7 +6,7 @@ "use strict";
 class Result {
-    SetStatusCode(statusCode, success) {
+    setStatusCode(statusCode, success) {
         this.statusCode = statusCode;
         this.success = success;
     }
-    SetMessage(message, statusCode) {
+    setMessage(message, statusCode) {
         this.message = message;
@@ -16,3 +16,3 @@ this.statusCode = statusCode;
     }
-    SetError(error, statusCode) {
+    setError(error, statusCode) {
         this.error = error;
@@ -22,3 +22,3 @@ this.statusCode = statusCode;
     }
-    SetData(data, statusCode, message) {
+    setData(data, statusCode, message) {
         this.data = data;
@@ -31,3 +31,3 @@ this.statusCode = statusCode;
     }
-    ToResultDto() {
+    toResultDto() {
         const result = new ResultDto_1.ResultDto();
@@ -34,0 +34,0 @@ result.error = this.error;

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

@@ -8,6 +8,6 @@ import { IResult } from "./Result.interface";
     error: string;
-    SetStatusCode(statusCode: number | string, success: boolean): void;
-    SetMessage(message: string, statusCode: number | string): void;
-    SetError(error: string, statusCode: number | string): void;
-    ToResultDto(): ResultDto;
+    setStatusCode(statusCode: number | string, success: boolean): void;
+    setMessage(message: string, statusCode: number | string): void;
+    setError(error: string, statusCode: number | string): void;
+    toResultDto(): ResultDto;
 }

lib/Result.interface.d.ts

@@ -7,7 +7,7 @@ import { ResultDto } from "./ResultDto";
     error: string;
-    SetStatusCode(statusCode: number | string, success: boolean): void;
-    SetMessage(message: string, statusCode: number | string): void;
-    SetError(error: string, statusCode: number | string): void;
-    ToResultDto(): ResultDto;
+    setStatusCode(statusCode: number | string, success: boolean): void;
+    setMessage(message: string, statusCode: number | string): void;
+    setError(error: string, statusCode: number | string): void;
+    toResultDto(): ResultDto;
 }
-export declare type IBaseResult = Omit<IResult, "ToResultDto">;
+export declare type IBaseResult = Omit<IResult, "toResultDto">;

lib/Result.js

@@ -6,7 +6,7 @@ "use strict";
 class Result {
-    SetStatusCode(statusCode, success) {
+    setStatusCode(statusCode, success) {
         this.statusCode = statusCode;
         this.success = success;
     }
-    SetMessage(message, statusCode) {
+    setMessage(message, statusCode) {
         this.message = message;
@@ -16,3 +16,3 @@ this.statusCode = statusCode;
     }
-    SetError(error, statusCode) {
+    setError(error, statusCode) {
         this.error = error;
@@ -22,3 +22,3 @@ this.statusCode = statusCode;
     }
-    ToResultDto() {
+    toResultDto() {
         const result = new ResultDto_1.ResultDto();
@@ -25,0 +25,0 @@ result.error = this.error;

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": "2.0.0",
   "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,5 +38,5 @@ );
 		}
-		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.
-		result.SetData(productDto, this.resultCodes.SUCCESS);
+		result.setData(productDto, this.resultCodes.SUCCESS);
 		// And finally you give it back.
@@ -61,6 +61,6 @@ return result;
 	itemDto.quantity = null;
-	const result = await addUseCase.Execute(userUid, itemDto);
+	const result = await addUseCase.execute(userUid, itemDto);
 	expect(result.success).toBeFalsy();
 	expect(result.error).toBe(
-		resources.GetWithParams(resourceKeys.SOME_PARAMETERS_ARE_MISSING, {
+		resources.getWithParams(resourceKeys.SOME_PARAMETERS_ARE_MISSING, {
 			missingParams: "quantity",
@@ -82,9 +82,9 @@ }),
   router: RouterType;
-  HandleResult(res: Response, result: IResult): void {
+  handleResult(res: Response, result: IResult): void {
     if (result.success) {
       res
         .status(result.statusCode)
-        .json(result.message ? result.ToResultDto() : result.ToResultDto().data);
+        .json(result.message ? result.toResultDto() : result.toResultDto().data);
     } else {
-      res.status(result.statusCode).json(result.ToResultDto());
+      res.status(result.statusCode).json(result.toResultDto());
     }
@@ -97,3 +97,3 @@ }
 	const textDto: TextDto = req.body;
-	this.HandleResult(res, await getLowestFeelingSentenceUseCase.Execute(textDto));
+	this.handleResult(res, await getLowestFeelingSentenceUseCase.execute(textDto));
 /*...*/
@@ -100,0 +100,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

13472

increased by2.09%

Lines of code

167

increased by0.6%

No dependency changes