type-plus - npm Package Compare versions

Comparing version 1.30.1 to 1.31.0

lib/assertType.d.ts

@@ -0,1 +1,2 @@
+import { UnionKeys } from './UnionKeys';
 /**
@@ -20,2 +21,3 @@ * assert the subject satisfies the specified type T
     var isNever: (value: never) => void;
+    var hasProperty: <T, P extends UnionKeys<T>>(value: T, prop: P) => asserts value is T & Record<P, T[P]>;
 }
@@ -22,0 +24,0 @@ /**

lib/assertType.js

@@ -22,2 +22,4 @@ "use strict";
 assertType.isNever = noop;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+assertType.hasProperty = function hasProperty(value, prop) { };
 // assertType.hasProperty = <T>(value: T, propertyName: KeyTypes)
@@ -24,0 +26,0 @@ function noop() { return; }

libm/assertType.d.ts

@@ -0,1 +1,2 @@
+import { UnionKeys } from './UnionKeys';
 /**
@@ -20,2 +21,3 @@ * assert the subject satisfies the specified type T
     var isNever: (value: never) => void;
+    var hasProperty: <T, P extends UnionKeys<T>>(value: T, prop: P) => asserts value is T & Record<P, T[P]>;
 }
@@ -22,0 +24,0 @@ /**

libm/assertType.js

@@ -19,2 +19,4 @@ /**
 assertType.isNever = noop;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+assertType.hasProperty = function hasProperty(value, prop) { };
 // assertType.hasProperty = <T>(value: T, propertyName: KeyTypes)
@@ -21,0 +23,0 @@ function noop() { return; }

package.json

 {
   "name": "type-plus",
-  "version": "1.30.1",
+  "version": "1.31.0",
   "description": "Provides additional types for `typescript`.",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/unional/type-plus",

README.md

@@ -103,2 +103,3 @@ # type-plus
 - `assertType.noXXX(value)`: ensure typeof `value` does not contain `XXX`. i.e. cannot assign `XXX` to `value`.
+- `assertType.hasProperty(value, prop)`: assert `value` has property `prop`. This will pick the correct union type.
 - `typeAssert.*` (deprecated) replaced by `assertType`.
@@ -105,0 +106,0 @@ - `typeAssertion<T>()`: creates a type assertion function of type `T`

src/assertType.spec.ts

@@ -171,1 +171,16 @@ import { assertType, typeAssertion } from '.';
 })
+
+describe('hasProperty', () => {
+  type X = { name: string } & ({ a: 1 } | { b: 2 })
+
+  const x: X = { name: 'n', a: 1 } as any
+
+  assertType.hasProperty(x, 'a')
+
+  expect(x.a).toBe(1)
+
+  const y: X = { name: 'n', b: 2 } as any
+  assertType.hasProperty(y, 'b')
+
+  expect(y.b).toBe(2)
+});

src/assertType.ts

@@ -0,1 +1,3 @@
+import { UnionKeys } from './UnionKeys'
+
 /**
@@ -20,2 +22,6 @@ * assert the subject satisfies the specified type T
 assertType.isNever = noop as (value: never) => void
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+assertType.hasProperty = function hasProperty<T, P extends UnionKeys<T>>(value: T, prop: P): asserts value is T & Record<P, T[P]> { }
+
 // assertType.hasProperty = <T>(value: T, propertyName: KeyTypes)
@@ -22,0 +28,0 @@ function noop() { return }

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

146050

increased by0.94%

Lines of code

2364

increased by0.85%

Number of lines in readme file

189

increased by0.53%

No dependency changes