@bedard/types - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

dist/index.d.ts

@@ -1,2 +0,2 @@
-declare const version = "0.3.0";
+declare const version = "0.4.0";
 export { Difference } from './Difference';
@@ -8,2 +8,3 @@ export { Equal } from './Equal';
 export { NotEqual } from './NotEqual';
+export { Opaque } from './Opaque';
 export { Pop } from './Pop';
@@ -10,0 +11,0 @@ export { Shift } from './Shift';

dist/index.esm.d.ts

@@ -1,2 +0,2 @@
-declare const version = "0.3.0";
+declare const version = "0.4.0";
 export { Difference } from './Difference';
@@ -8,2 +8,3 @@ export { Equal } from './Equal';
 export { NotEqual } from './NotEqual';
+export { Opaque } from './Opaque';
 export { Pop } from './Pop';
@@ -10,0 +11,0 @@ export { Shift } from './Shift';

dist/index.esm.js

@@ -1,3 +0,3 @@
-const version = '0.3.0';
+const version = '0.4.0';
 
 export { version };

dist/index.js

@@ -5,4 +5,4 @@ 'use strict';
 
-const version = '0.3.0';
+const version = '0.4.0';
 
 exports.version = version;

package.json

@@ -30,3 +30,3 @@ {
   },
-  "version": "0.3.0"
+  "version": "0.4.0"
 }

README.md

@@ -27,2 +27,3 @@ # `@bedard/types`
 - [`NotEqual<A, B>`](#notequala-b)
+- [`Opaque<T, Token>`](#opaquet-token)
 - [`Pop<T>`](#popt)
@@ -98,2 +99,14 @@ - [`Shift<T>`](#shiftt)
 
+### `Opaque<T, Token>`
+
+[Opaque type](https://en.wikipedia.org/wiki/Opaque_data_type) `T` with an optional `Token`. For more on opaque types, [this article](https://codemix.com/opaque-types-in-javascript) is a great place to start.
+
+```ts
+import { Opaque } from '@bedard/types'
+
+type USD = Opaque<number, 'usd'>
+
+const dollars = 5 as USD
+```
+
 ### `Pop<T>`
@@ -100,0 +113,0 @@

src/index.ts

@@ -7,2 +7,3 @@ export { Difference } from './Difference'
 export { NotEqual } from './NotEqual'
+export { Opaque } from './Opaque'
 export { Pop } from './Pop'
@@ -16,2 +17,2 @@ export { Shift } from './Shift'
 
-export const version = '0.3.0'
+export const version = '0.4.0'

No alert changes

Improved metrics

Total package byte prevSize

24956

increased by11.66%

Number of package files

56

increased by7.69%

Lines of code

549

increased by8.07%

Number of lines in readme file

191

increased by7.3%

No dependency changes