defekt - npm Package Compare versions

Comparing version 7.0.4 to 7.1.0

build/lib/index.d.ts

@@ -6,3 +6,4 @@ import { CustomError } from './CustomError';
 import { isError } from './isError';
+import { isResult } from './isResult';
 import { error, Result, value } from './Result';
-export { CustomError, defekt, error, ErrorConstructor, isCustomError, isError, Result, value };
+export { CustomError, defekt, error, ErrorConstructor, isCustomError, isError, isResult, Result, value };

build/lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.value = exports.isError = exports.isCustomError = exports.error = exports.defekt = void 0;
+exports.value = exports.isResult = exports.isError = exports.isCustomError = exports.error = exports.defekt = void 0;
 const defekt_1 = require("./defekt");
@@ -10,4 +10,6 @@ Object.defineProperty(exports, "defekt", { enumerable: true, get: function () { return defekt_1.defekt; } });
 Object.defineProperty(exports, "isError", { enumerable: true, get: function () { return isError_1.isError; } });
+const isResult_1 = require("./isResult");
+Object.defineProperty(exports, "isResult", { enumerable: true, get: function () { return isResult_1.isResult; } });
 const Result_1 = require("./Result");
 Object.defineProperty(exports, "error", { enumerable: true, get: function () { return Result_1.error; } });
 Object.defineProperty(exports, "value", { enumerable: true, get: function () { return Result_1.value; } });

CHANGELOG.md

@@ -0,1 +1,8 @@
+# [7.1.0](https://github.com/thenativeweb/defekt/compare/7.0.4...7.1.0) (2021-03-29)
+
+
+### Features
+
+* Add type-guard isResult. ([#297](https://github.com/thenativeweb/defekt/issues/297)) ([2d1e15a](https://github.com/thenativeweb/defekt/commit/2d1e15a51a853edb961c4ede8970ec9cbcac54fe))
+
 ## [7.0.4](https://github.com/thenativeweb/defekt/compare/7.0.3...7.0.4) (2021-03-25)
@@ -2,0 +9,0 @@

lib/index.ts

@@ -6,2 +6,3 @@ import { CustomError } from './CustomError';
 import { isError } from './isError';
+import { isResult } from './isResult';
 import { error, Result, value } from './Result';
@@ -16,4 +17,5 @@
   isError,
+  isResult,
   Result,
   value
 };

package.json

 {
   "name": "defekt",
-  "version": "7.0.4",
+  "version": "7.1.0",
   "description": "defekt is custom errors made simple.",
@@ -35,4 +35,4 @@ "contributors": [
   "devDependencies": {
-    "assertthat": "5.2.6",
-    "roboter": "11.6.30",
+    "assertthat": "5.2.8",
+    "roboter": "11.6.35",
     "semantic-release-configuration": "2.0.0"
@@ -39,0 +39,0 @@ },

README.md

@@ -269,2 +269,16 @@ # defekt
 
+### Recognizing a `Result`
+
+If you need to assert the type of a `Result`, you can use the `isResult` type-guard:
+
+```typescript
+import { isResult } from 'defekt';
+
+const someValue: any = someFunction();
+
+if (isResult(someValue)) {
+  // In this scope someValue is of type Result<any, any>.
+}
+```
+
 ## Running quality assurance
@@ -271,0 +285,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30495

increased by8.27%

Number of package files

34

increased by9.68%

Lines of code

420

increased by9.38%

Number of lines in readme file

290

increased by5.07%

No dependency changes