@guanghechen/invariant 7.0.0 → 7.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -43,8 +43,8 @@
 </header>
 <br/>
 
-An invariant function, which takes a `condition` and an optional `message` value,
-and throws an error when the given condition fails.
+A simple invariant function that throws an error when the given condition fails. Error messages are
+stripped in production builds (`NODE_ENV === 'production'`) for smaller bundle size.
 
 ## Install
 
@@ -60,29 +60,67 @@ and throws an error when the given condition fails.
   yarn add @guanghechen/invariant
   ```
 
-
 ## Usage
 
-- Syntax
+### Basic Usage
 
-  ```typescript
-  function invariant(
-    condition: boolean,
-    message?: string | (() => string),
-  ): asserts condition
-  ```
+```typescript
+import invariant from '@guanghechen/invariant'
 
-- Demo
+function divide(a: number, b: number): number {
+  invariant(b !== 0, 'Division by zero is not allowed')
+  return a / b
+}
 
-  ```typescript
-  import invariant from '@guanghechen/invariant'
+divide(10, 2) // 5
+divide(10, 0) // throws Error: "Invariant failed: Division by zero is not allowed"
+```
 
-  invariant(typeof window !== 'undefined', '`window` is not defined.')
-  invariant(typeof window !== 'undefined', () => '`window` is not defined:' + window)
-  ```
+### With Lazy Message
+
+Use a function for expensive message computation:
+
+```typescript
+import { invariant } from '@guanghechen/invariant'
+
+function processUser(user: User | null) {
+  invariant(user !== null, () => `User not found: ${JSON.stringify(context)}`)
+  // TypeScript now knows `user` is not null
+  return user.name
+}
+```
+
+### TypeScript Type Narrowing
+
+The function uses `asserts condition` for proper type narrowing:
+
+```typescript
+import invariant from '@guanghechen/invariant'
+
+function getValue(map: Map<string, number>, key: string): number {
+  const value = map.get(key)
+  invariant(value !== undefined, `Key "${key}" not found in map`)
+  // TypeScript knows `value` is `number` here, not `number | undefined`
+  return value
+}
+```
+
+### API
+
+```typescript
+function invariant(
+  condition: boolean,
+  message?: string | (() => string) | null,
+): asserts condition
+```
+
+- `condition`: The condition to assert. If falsy, an error is thrown.
+- `message`: Optional error message (string or function returning string).
 
+## Reference
 
-## Related
+- [homepage][homepage]
+- Inspired by [tiny-invariant][tiny-invariant]
 
 [homepage]: https://github.com/guanghechen/sora/tree/@guanghechen/invariant@7.0.0/packages/invariant#readme
 [tiny-invariant]: https://github.com/alexreardon/tiny-invariant

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/invariant",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "A simple invariant function",
   "author": {
     "name": "guanghechen",
@@ -8,17 +8,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/invariant@6.0.5",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/invariant@7.0.0",
     "directory": "packages/invariant"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/invariant@6.0.5/packages/invariant#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/invariant@7.0.0/packages/invariant#readme",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -26,16 +26,6 @@
   "module": "./lib/esm/index.mjs",
   "types": "./lib/types/index.d.ts",
   "license": "MIT",
-  "scripts": {
-    "build": "rollup -c ../../rollup.config.mjs",
-    "clean": "rimraf lib",
-    "test": "vitest run --config ../../vitest.config.ts",
-    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
-    "test:update": "vitest run --config ../../vitest.config.ts -u"
-  },
-  "engines": {
-    "node": ">= 18.0.0"
-  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -44,5 +34,11 @@
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "12990a720b31d50d217e2e17a6191256dc94eda6"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}