@rickosborne/guard 2024.12.29 → 2024.12.30

package/README.md

@@ -1,4 +1,4 @@
-**@rickosborne/guard v2024.12.29**
+**@rickosborne/guard v2024.12.30**
 
 ***
 
@@ -10,106 +10,28 @@ Basic type guards building on [@rickosborne/typical](https://www.npmjs.com/packa
 
 ### MessageOrError
 
-```ts
-type MessageOrError = string | Error | () => string | Error;
-```
+> **MessageOrError**: string \| Error \| () => string \| Error
 
 A message, an error, or something which can generate one of those.
 
 ## Functions
 
-### assertDefined()
-
-```ts
-function assertDefined<T>(value, messageOrError): asserts value is NonNullable<T>
-```
-
-#### Type Parameters
-
-• **T**
-
-#### Parameters
-
-##### value
-
-`T`
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`asserts value is NonNullable<T>`
+> **assertDefined**\<T\>(value, messageOrError): asserts value is NonNullable<T>
 
 ***
 
-### assertInt()
-
-```ts
-function assertInt(value, messageOrError): asserts value is number
-```
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`asserts value is number`
+> **assertInt**(value, messageOrError): asserts value is number
 
 ***
 
-### errorFromMessageOrError()
-
-```ts
-function errorFromMessageOrError(messageOrError, defaultConstructor): Error
-```
+> **errorFromMessageOrError**(messageOrError, defaultConstructor): Error
 
 Helper for guards which expect text or an error, or
 can generate one when needed.
 
-#### Parameters
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-##### defaultConstructor
-
-(`message`) => `Error`
-
-#### Returns
-
-`Error`
-
 ***
 
-### expectInt()
-
-```ts
-function expectInt(obj, messageOrError): number
-```
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`number`
+> **expectInt**(obj, messageOrError): number
 
 ***
 
@@ -119,12 +41,7 @@ Guard for whether the given value is an object which has a property with its own
 
 #### Call Signature
 
-```ts
-function hasArray<Name>(
-   obj, 
-   name, 
-   predicate?): obj is { [K in string]: unknown[] }
-```
+> **hasArray**\<Name\>(obj, name, predicate?): obj is { [K in string]: unknown[] }
 
 Guard for whether the given value is an object which has a property with its own array value.
 This variant does not exhaustively check the items of the array.
@@ -133,32 +50,9 @@ This variant does not exhaustively check the items of the array.
 
 • **Name** *extends* `string`
 
-##### Parameters
-
-###### obj
-
-`unknown`
-
-###### name
-
-`Name`
-
-###### predicate?
-
-`undefined`
-
-##### Returns
-
-`obj is { [K in string]: unknown[] }`
-
 #### Call Signature
 
-```ts
-function hasArray<Name, Item>(
-   obj, 
-   name, 
-   predicate?): obj is { [K in string]: Item[] }
-```
+> **hasArray**\<Name, Item\>(obj, name, predicate?): obj is { [K in string]: Item[] }
 
 Guard for whether the given value is an object which has a property with its own array value.
 This variant exhaustively checks the items of the array against the given predicate.
@@ -169,86 +63,29 @@ This variant exhaustively checks the items of the array against the given predic
 
 • **Item**
 
-##### Parameters
-
-###### obj
-
-`unknown`
-
-###### name
-
-`Name`
-
-###### predicate?
-
-(`item`, `index`, `items`) => `item is Item`
-
-##### Returns
-
-`obj is { [K in string]: Item[] }`
-
 ***
 
-### hasNumber()
-
-```ts
-function hasNumber<Name>(obj, name): obj is { [k in string]: string }
-```
+> **hasNumber**\<Name\>(obj, name): obj is { [k in string]: string }
 
 #### Type Parameters
 
 • **Name** *extends* `string`
 
-#### Parameters
-
-##### obj
-
-`unknown`
-
-##### name
-
-`Name`
-
-#### Returns
-
-`obj is { [k in string]: string }`
-
 ***
 
 ### hasOwn()
 
 #### Call Signature
 
-```ts
-function hasOwn<Name>(obj, name): obj is { [K in string]: unknown }
-```
+> **hasOwn**\<Name\>(obj, name): obj is { [K in string]: unknown }
 
 ##### Type Parameters
 
 • **Name** *extends* `string`
 
-##### Parameters
-
-###### obj
-
-`unknown`
-
-###### name
-
-`Name`
-
-##### Returns
-
-`obj is { [K in string]: unknown }`
-
 #### Call Signature
 
-```ts
-function hasOwn<Name, T>(
-   obj, 
-   name, 
-   predicate): obj is { [K in string]: T }
-```
+> **hasOwn**\<Name, T\>(obj, name, predicate): obj is { [K in string]: T }
 
 ##### Type Parameters
 
@@ -256,123 +93,28 @@ function hasOwn<Name, T>(
 
 • **T**
 
-##### Parameters
-
-###### obj
-
-`unknown`
-
-###### name
-
-`Name`
-
-###### predicate
-
-(`value`) => `value is T`
-
-##### Returns
-
-`obj is { [K in string]: T }`
-
 ***
 
-### isInt()
-
-```ts
-function isInt(obj): obj is number
-```
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-#### Returns
-
-`obj is number`
+> **isInt**(obj): obj is number
 
 ***
 
-### isListOf()
-
-```ts
-function isListOf<T>(list, predicate): list is T[]
-```
-
-#### Type Parameters
-
-• **T**
-
-#### Parameters
-
-##### list
-
-`unknown`
-
-##### predicate
-
-(`item`, `index`, `items`) => `item is T`
-
-#### Returns
-
-`list is T[]`
+> **isListOf**\<T\>(list, predicate): list is T[]
 
 ***
 
-### isObject()
-
-```ts
-function isObject(obj): obj is object
-```
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-#### Returns
-
-`obj is object`
+> **isObject**(obj): obj is object
 
 ***
 
-### isPlainObject()
-
-```ts
-function isPlainObject(obj): obj is Record<never, never>
-```
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-#### Returns
-
-`obj is Record<never, never>`
+> **isPlainObject**(obj): obj is Record<never, never>
 
 ***
 
-### isUnaryPredicate()
-
-```ts
-function isUnaryPredicate(obj): obj is UnaryPredicate<unknown>
-```
+> **isUnaryPredicate**(obj): obj is UnaryPredicate<unknown>
 
 Tests whether the given object is a function and takes at
 least one parameter, and could maybe act as a unary predicate.
 Warning!  Since no type information is available at runtime,
 it may not actually act as a predicate!
 
-#### Parameters
-
-##### obj
-
-`unknown`
-
-#### Returns
-
-`obj is UnaryPredicate<unknown>`

package/package.json

@@ -4,7 +4,7 @@
 		"url": "https://rickosborne.org"
 	},
 	"dependencies": {
-		"@rickosborne/typical": "2024.12.29"
+		"@rickosborne/typical": "2024.12.30"
 	},
 	"description": "Rick Osborne's collection of type guards.",
 	"engines": {
@@ -31,5 +31,5 @@
 		"type": "git",
 		"url": "git+https://github.com/rickosborne/es-js-ts.git"
 	},
-	"version": "2024.12.29"
+	"version": "2024.12.30"
 }