ts-tiny-invariant - npm Package Compare versions

Comparing version 1.0.5 to 1.0.7

package.json

 {
   "name": "ts-tiny-invariant",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Stricter version of tiny-invariant",
@@ -56,3 +56,3 @@ "sideEffects": false,
     "tslint-config-standard": "^9.0.0",
-    "typescript": "^4.4.4"
+    "typescript": "^4.6.3"
   },
@@ -59,0 +59,0 @@ "jest": {

README.md

 # ts-tiny-invariant
 
 [![npm](https://img.shields.io/npm/v/ts-tiny-invariant)](https://npm.im/ts-tiny-invariant)
-[![CircleCI](https://circleci.com/gh/iyegoroff/ts-tiny-invariant.svg?style=svg)](https://circleci.com/gh/iyegoroff/ts-tiny-invariant)
+[![build](https://github.com/iyegoroff/ts-tiny-invariant/workflows/build/badge.svg)](https://github.com/iyegoroff/ts-tiny-invariant/actions/workflows/build.yml)
+[![publish](https://github.com/iyegoroff/ts-tiny-invariant/workflows/publish/badge.svg)](https://github.com/iyegoroff/ts-tiny-invariant/actions/workflows/publish.yml)
 ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/ts-tiny-invariant)
-[![Bundlephobia](https://badgen.net/bundlephobia/minzip/ts-tiny-invariant?label=min+gzip)](https://bundlephobia.com/package/ts-tiny-invariant)
+[![Bundlephobia](https://img.shields.io/bundlephobia/minzip/ts-tiny-invariant?label=min+gzip)](https://bundlephobia.com/package/ts-tiny-invariant)
 [![npm](https://img.shields.io/npm/l/ts-tiny-invariant.svg?t=1495378566925)](https://www.npmjs.com/package/ts-tiny-invariant)
 
+<!-- [![Bundlephobia](https://badgen.net/bundlephobia/minzip/ts-tiny-invariant?label=min+gzip)](https://bundlephobia.com/package/ts-tiny-invariant) -->
+
 Stricter version of [tiny-invariant](https://github.com/alexreardon/tiny-invariant) that accepts only `boolean` condition
@@ -14,1 +17,15 @@
 `$ npm i ts-tiny-invariant`
+
+## Usage
+
+```ts
+import invariant from 'ts-tiny-invariant'
+
+expect(() => {
+  invariant(false, 'fail')
+}).toThrow('Invariant failed: fail')
+
+expect(() => {
+  invariant(true, 'pass')
+}).not.toThrow()
+```

No alert changes

Improved metrics

Total package byte prevSize

6393

increased by9.47%

Number of lines in readme file

31

increased by121.43%

No dependency changes