@rickosborne/guard 2024.12.28 → 2024.12.29

package/README.md

@@ -1,4 +1,4 @@
-**@rickosborne/guard v2024.12.28**
+**@rickosborne/guard v2024.12.29**
 
 ***
 
@@ -8,19 +8,371 @@ Basic type guards building on [@rickosborne/typical](https://www.npmjs.com/packa
 
 ## Type Aliases
 
-- [MessageOrError](type-aliases/MessageOrError.md)
+### MessageOrError
+
+```ts
+type MessageOrError = string | Error | () => string | Error;
+```
+
+A message, an error, or something which can generate one of those.
 
 ## Functions
 
-- [assertDefined](functions/assertDefined.md)
-- [assertInt](functions/assertInt.md)
-- [errorFromMessageOrError](functions/errorFromMessageOrError.md)
-- [expectInt](functions/expectInt.md)
-- [hasArray](functions/hasArray.md)
-- [hasNumber](functions/hasNumber.md)
-- [hasOwn](functions/hasOwn.md)
-- [isInt](functions/isInt.md)
-- [isListOf](functions/isListOf.md)
-- [isObject](functions/isObject.md)
-- [isPlainObject](functions/isPlainObject.md)
-- [isUnaryPredicate](functions/isUnaryPredicate.md)
+### 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>`
+
+***
+
+### assertInt()
+
+```ts
+function assertInt(value, messageOrError): asserts value is number
+```
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+##### messageOrError
+
+[`MessageOrError`](README.md#messageorerror)
+
+#### Returns
+
+`asserts value is number`
+
+***
+
+### errorFromMessageOrError()
+
+```ts
+function 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`
+
+***
+
+### hasArray()
+
+Guard for whether the given value is an object which has a property with its own array value.
+
+#### Call Signature
+
+```ts
+function 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.
+
+##### Type Parameters
+
+• **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[] }
+```
+
+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.
+
+##### Type Parameters
+
+• **Name** *extends* `string`
+
+• **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 }
+```
+
+#### 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 }
+```
+
+##### 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 }
+```
+
+##### Type Parameters
+
+• **Name** *extends* `string`
+
+• **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`
+
+***
+
+### 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[]`
+
+***
+
+### isObject()
+
+```ts
+function isObject(obj): obj is object
+```
+
+#### Parameters
+
+##### obj
+
+`unknown`
+
+#### Returns
+
+`obj is object`
+
+***
+
+### isPlainObject()
+
+```ts
+function isPlainObject(obj): obj is Record<never, never>
+```
+
+#### Parameters
+
+##### obj
+
+`unknown`
+
+#### Returns
+
+`obj is Record<never, never>`
+
+***
+
+### isUnaryPredicate()
+
+```ts
+function 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.28"
+		"@rickosborne/typical": "2024.12.29"
 	},
 	"description": "Rick Osborne's collection of type guards.",
 	"engines": {
@@ -27,8 +27,9 @@
 		"access": "public"
 	},
 	"repository": {
+		"directory": "guard",
 		"type": "git",
 		"url": "git+https://github.com/rickosborne/es-js-ts.git"
 	},
-	"version": "2024.12.28"
+	"version": "2024.12.29"
 }

package/functions/assertDefined.md

@@ -1,31 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / assertDefined
-
-# Function: assertDefined()
-
-> **assertDefined**\<`T`\>(`value`, `messageOrError`): `asserts value is NonNullable<T>`
-
-## Type Parameters
-
-• **T**
-
-## Parameters
-
-### value
-
-`T`
-
-### messageOrError
-
-[`MessageOrError`](../type-aliases/MessageOrError.md)
-
-## Returns
-
-`asserts value is NonNullable<T>`
-
-## Defined in
-
-[assert-defined.ts:3](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/assert-defined.ts#L3)

package/functions/assertInt.md

@@ -1,27 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / assertInt
-
-# Function: assertInt()
-
-> **assertInt**(`value`, `messageOrError`): `asserts value is number`
-
-## Parameters
-
-### value
-
-`unknown`
-
-### messageOrError
-
-[`MessageOrError`](../type-aliases/MessageOrError.md)
-
-## Returns
-
-`asserts value is number`
-
-## Defined in
-
-[is-int.ts:5](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-int.ts#L5)

package/functions/errorFromMessageOrError.md

@@ -1,30 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / errorFromMessageOrError
-
-# Function: errorFromMessageOrError()
-
-> **errorFromMessageOrError**(`messageOrError`, `defaultConstructor`): `Error`
-
-Helper for guards which expect text or an error, or
-can generate one when needed.
-
-## Parameters
-
-### messageOrError
-
-[`MessageOrError`](../type-aliases/MessageOrError.md)
-
-### defaultConstructor
-
-(`message`) => `Error`
-
-## Returns
-
-`Error`
-
-## Defined in
-
-[error-from-message.ts:10](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/error-from-message.ts#L10)

package/functions/expectInt.md

@@ -1,27 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / expectInt
-
-# Function: expectInt()
-
-> **expectInt**(`obj`, `messageOrError`): `number`
-
-## Parameters
-
-### obj
-
-`unknown`
-
-### messageOrError
-
-[`MessageOrError`](../type-aliases/MessageOrError.md)
-
-## Returns
-
-`number`
-
-## Defined in
-
-[is-int.ts:11](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-int.ts#L11)

package/functions/hasArray.md

@@ -1,77 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / hasArray
-
-# Function: hasArray()
-
-Guard for whether the given value is an object which has a property with its own array value.
-
-## Call Signature
-
-> **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.
-
-### Type Parameters
-
-• **Name** *extends* `string`
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### name
-
-`Name`
-
-#### predicate?
-
-`undefined`
-
-### Returns
-
-`obj is { [K in string]: unknown[] }`
-
-### Defined in
-
-[has-array.ts:8](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/has-array.ts#L8)
-
-## Call Signature
-
-> **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.
-
-### Type Parameters
-
-• **Name** *extends* `string`
-
-• **Item**
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### name
-
-`Name`
-
-#### predicate?
-
-(`item`, `index`, `items`) => `item is Item`
-
-### Returns
-
-`obj is { [K in string]: Item[] }`
-
-### Defined in
-
-[has-array.ts:13](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/has-array.ts#L13)

package/functions/hasNumber.md

@@ -1,31 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / hasNumber
-
-# Function: hasNumber()
-
-> **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 }`
-
-## Defined in
-
-[has-number.ts:3](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/has-number.ts#L3)

package/functions/hasOwn.md

@@ -1,65 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / hasOwn
-
-# Function: hasOwn()
-
-## Call Signature
-
-> **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 }`
-
-### Defined in
-
-[has-own.ts:3](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/has-own.ts#L3)
-
-## Call Signature
-
-> **hasOwn**\<`Name`, `T`\>(`obj`, `name`, `predicate`): `obj is { [K in string]: T }`
-
-### Type Parameters
-
-• **Name** *extends* `string`
-
-• **T**
-
-### Parameters
-
-#### obj
-
-`unknown`
-
-#### name
-
-`Name`
-
-#### predicate
-
-(`value`) => `value is T`
-
-### Returns
-
-`obj is { [K in string]: T }`
-
-### Defined in
-
-[has-own.ts:4](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/has-own.ts#L4)

package/functions/isInt.md

@@ -1,23 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / isInt
-
-# Function: isInt()
-
-> **isInt**(`obj`): `obj is number`
-
-## Parameters
-
-### obj
-
-`unknown`
-
-## Returns
-
-`obj is number`
-
-## Defined in
-
-[is-int.ts:3](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-int.ts#L3)

package/functions/isListOf.md

@@ -1,31 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / isListOf
-
-# Function: isListOf()
-
-> **isListOf**\<`T`\>(`list`, `predicate`): `list is T[]`
-
-## Type Parameters
-
-• **T**
-
-## Parameters
-
-### list
-
-`unknown`
-
-### predicate
-
-(`item`, `index`, `items`) => `item is T`
-
-## Returns
-
-`list is T[]`
-
-## Defined in
-
-[is-list-of.ts:1](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-list-of.ts#L1)

package/functions/isObject.md

@@ -1,23 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / isObject
-
-# Function: isObject()
-
-> **isObject**(`obj`): `obj is object`
-
-## Parameters
-
-### obj
-
-`unknown`
-
-## Returns
-
-`obj is object`
-
-## Defined in
-
-[is-object.ts:1](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-object.ts#L1)

package/functions/isPlainObject.md

@@ -1,23 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / isPlainObject
-
-# Function: isPlainObject()
-
-> **isPlainObject**(`obj`): `obj is Record<never, never>`
-
-## Parameters
-
-### obj
-
-`unknown`
-
-## Returns
-
-`obj is Record<never, never>`
-
-## Defined in
-
-[is-object.ts:5](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-object.ts#L5)

package/functions/isUnaryPredicate.md

@@ -1,28 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / isUnaryPredicate
-
-# Function: isUnaryPredicate()
-
-> **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>`
-
-## Defined in
-
-[is-predicate.ts:9](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/is-predicate.ts#L9)

package/type-aliases/MessageOrError.md

@@ -1,15 +0,0 @@
-[**@rickosborne/guard v2024.12.28**](../README.md)
-
-***
-
-[@rickosborne/guard](../README.md) / MessageOrError
-
-# Type Alias: MessageOrError
-
-> **MessageOrError**: `string` \| `Error` \| () => `string` \| `Error`
-
-A message, an error, or something which can generate one of those.
-
-## Defined in
-
-[error-from-message.ts:4](https://github.com/rickosborne/es-js-ts/blob/b9df3c6eb00a5aca153cd4895e7af44eeb074ddb/guard/ts/error-from-message.ts#L4)