@kensio/smartass 0.0.2 → 0.0.4

package/README.md

@@ -12,67 +12,38 @@ unable to provide type information to TypeScript and IntelliSense.
 This library provides assertion functions with assertion signatures so that you
 can benefit from the extra type information.
 
-## Installation
-
-```bash
-npm install @kensio/smartass
-```
-
-## Usage
-
-### assertNonNullable
-
-Assert that a value is neither null nor undefined, with type narrowing.
-
 ```typescript
 import { assertNonNullable } from '@kensio/smartass';
 
-test('user has a name', () => {
-  const user = getUser();
-  assertNonNullable(user);
-  // TypeScript now knows user is neither null nor undefined, so no need
-  // for ! or ? operators.
-  expect(user.name).toBe('Alice');
-});
+const user: { name: string } | undefined = getUser();
+assertNonNullable(user);
+// TypeScript now knows user is neither null nor undefined,
+// so no need for ? or ! operators.
+const userName = user.name;
 ```
 
-### assertNotEmpty
-
-Assert that an array is non-empty, with type narrowing to a tuple type.
-
-```typescript
-import { assertNotEmpty } from '@kensio/smartass';
-
-test('first item is correct', () => {
-  const items: string[] = getItems();
-  assertNotEmpty(items);
-  // TypeScript now knows items is an array of strings with at
-  // least one element, so no need for ? operator.
-  expect(items[0]).toBe('first');
-});
-```
-
-### assertOneOf
-
-Assert that a value is one of a set of allowed values, with type narrowing.
-
 ```typescript
 import { assertOneOf } from '@kensio/smartass';
 
-test('status is valid', () => {
-  const status = getStatus();
-  assertOneOf(status, ['pending', 'active', 'completed'] as const);
-  // TypeScript now knows status is 'pending' | 'active' | 'completed'
-  expect(status).toBe('active');
-});
+const status = getStatus();
+assertOneOf(status, ['pending', 'active', 'completed']);
+// TypeScript now knows status is of type 'pending' | 'active' | 'completed'
 ```
 
-## Custom Error Messages
-
-All assertion functions accept an optional custom error message:
+## Installation
 
-```typescript
-assertNonNullable(user, 'User must be provided');
-assertNotEmpty(items, 'Items array cannot be empty');
-assertOneOf(status, ['open', 'closed'], 'Status must be either open or closed');
+```bash
+npm install @kensio/smartass
 ```
+
+## Assertion functions
+
+- [assertNonNullable](src/assert/non-nullable/non-nullable.assert.ts)
+- [assertNotEmpty](src/assert/not-empty/not-empty.assert.ts)
+- [assertOneOf](src/assert/one-of/one-of.assert.ts)
+- [assertTypeBigInt](src/assert/type-bigint/type-bigint.assert.ts)
+- [assertTypeBoolean](src/assert/type-boolean/type-boolean.assert.ts)
+- [assertTypeFunction](src/assert/type-function/type-function.assert.ts)
+- [assertTypeNumber](src/assert/type-number/type-number.assert.ts)
+- [assertTypeObject](src/assert/type-object/type-object.assert.ts)
+- [assertTypeString](src/assert/type-string/type-string.assert.ts)

package/package.json

@@ -4,7 +4,7 @@
   "author": "Kensio Software",
   "repository": "https://github.com/KensioSoftware/smartass",
   "license": "AGPL-3.0",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -21,6 +21,9 @@
     "access": "public"
   },
   "sideEffects": false,
+  "engines": {
+    "node": ">=24.14.0"
+  },
   "keywords": [
     "test",
     "assertion",
@@ -48,8 +51,8 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "fmt": "eslint --fix '{src,test}/**/*.{ts,js}' && prettier --write '{src,test}/**/*.{ts,js,json,md,css,html,yml,yaml}'",
-    "lint": "eslint '{src,test}/**/*.{ts,js}' && prettier --check '{src,test}/**/*.{ts,js,json,md,css,html,yml,yaml}'",
+    "fmt": "eslint --fix '{src,test}/**/*.ts' && prettier --write '{src,test}/**/*.{ts,json,md,css,html,yml,yaml}'",
+    "lint": "eslint '{src,test}/**/*.ts' && prettier --check '{src,test}/**/*.{ts,json,md,css,html,yml,yaml}'",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage"
   }