@rickosborne/guard 2024.12.29 → 2024.12.32

package/README.md

@@ -1,378 +1,154 @@
-**@rickosborne/guard v2024.12.29**
-
-***
-
 # @rickosborne/guard
 
 Basic type guards building on [@rickosborne/typical](https://www.npmjs.com/package/@rickosborne/typical).
+***
 
-## Type Aliases
-
-### MessageOrError
-
-```ts
-type MessageOrError = string | Error | () => string | Error;
-```
+## API
 
-A message, an error, or something which can generate one of those.
+### Functions
 
-## Functions
+#### assertDefined
 
-### assertDefined()
+<a id="api-assertdefined"></a>
 
-```ts
-function assertDefined<T>(value, messageOrError): asserts value is NonNullable<T>
+```typescript
+declare function assertDefined<T>(value: T, messageOrError: MessageOrError): asserts value is NonNullable<T>;
 ```
 
-#### Type Parameters
+#### assertInt
 
-• **T**
+<a id="api-assertint"></a>
 
-#### Parameters
-
-##### value
-
-`T`
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`asserts value is NonNullable<T>`
-
-***
-
-### assertInt()
-
-```ts
-function assertInt(value, messageOrError): asserts value is number
+```typescript
+declare function assertInt(value: unknown, messageOrError: MessageOrError): asserts value is number;
 ```
 
-#### Parameters
-
-##### value
-
-`unknown`
+#### errorFromMessageOrError
 
-##### messageOrError
+<a id="api-errorfrommessageorerror"></a>
 
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`asserts value is number`
-
-***
-
-### errorFromMessageOrError()
-
-```ts
-function errorFromMessageOrError(messageOrError, defaultConstructor): Error
+```typescript
+errorFromMessageOrError: (messageOrError: MessageOrError, defaultConstructor?: (new (message: string) => Error)) => 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`
+Helper for guards which expect text or an error, or can generate one when needed.
 
-#### Returns
 
-`Error`
+#### expectInt
 
-***
-
-### expectInt()
+<a id="api-expectint"></a>
 
-```ts
-function expectInt(obj, messageOrError): number
+```typescript
+expectInt: (obj: unknown, messageOrError: MessageOrError) => number
 ```
 
-#### Parameters
-
-##### obj
-
-`unknown`
-
-##### messageOrError
-
-[`MessageOrError`](README.md#messageorerror)
-
-#### Returns
-
-`number`
+#### hasArray
 
-***
-
-### hasArray()
-
-Guard for whether the given value is an object which has a property with its own array value.
-
-#### Call Signature
+<a id="api-hasarray"></a>
 
-```ts
-function hasArray<Name>(
-   obj, 
-   name, 
-   predicate?): obj is { [K in string]: unknown[] }
+```typescript
+declare function hasArray<Name extends string>(obj: unknown, name: Name, predicate?: undefined): obj is {
+    [K in Name]: 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
+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.
 
-`unknown`
 
-###### name
+#### hasArray
 
-`Name`
+<a id="api-hasarray"></a>
 
-###### 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[] }
+```typescript
+declare function hasArray<Name extends string, Item>(obj: unknown, name: Name, predicate?: (item: unknown, index: number, items: unknown[]) => item is Item): obj is {
+    [K in Name]: 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**
+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.
 
-##### Parameters
 
-###### obj
+#### hasNumber
 
-`unknown`
+<a id="api-hasnumber"></a>
 
-###### 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 }
+```typescript
+hasNumber: <Name extends string>(obj: unknown, name: Name) => obj is { [k in Name]: string; }
 ```
 
-#### Type Parameters
-
-• **Name** *extends* `string`
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-##### name
-
-`Name`
+#### hasOwn
 
-#### Returns
+<a id="api-hasown"></a>
 
-`obj is { [k in string]: string }`
-
-***
-
-### hasOwn()
-
-#### Call Signature
-
-```ts
-function hasOwn<Name>(obj, name): obj is { [K in string]: unknown }
+```typescript
+declare function hasOwn<Name extends string>(obj: unknown, name: Name): obj is {
+    [K in Name]: unknown;
+};
 ```
 
-##### Type Parameters
-
-• **Name** *extends* `string`
-
-##### Parameters
-
-###### obj
+#### hasOwn
 
-`unknown`
+<a id="api-hasown"></a>
 
-###### 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 }
+```typescript
+declare function hasOwn<Name extends string, T>(obj: unknown, name: Name, predicate: (value: unknown) => value is T): obj is {
+    [K in Name]: T;
+};
 ```
 
-##### Type Parameters
-
-• **Name** *extends* `string`
-
-• **T**
-
-##### Parameters
-
-###### obj
-
-`unknown`
-
-###### name
-
-`Name`
-
-###### predicate
-
-(`value`) => `value is T`
-
-##### Returns
+#### isInt
 
-`obj is { [K in string]: T }`
+<a id="api-isint"></a>
 
-***
-
-### isInt()
-
-```ts
-function isInt(obj): obj is number
+```typescript
+isInt: (obj: unknown) => obj is number
 ```
 
-#### Parameters
-
-##### obj
+#### isListOf
 
-`unknown`
-
-#### Returns
-
-`obj is number`
-
-***
+<a id="api-islistof"></a>
 
-### isListOf()
-
-```ts
-function isListOf<T>(list, predicate): list is T[]
+```typescript
+isListOf: <T>(list: unknown, predicate: (item: unknown, index: number, items: unknown[]) => item is T) => list is T[]
 ```
 
-#### Type Parameters
-
-• **T**
-
-#### Parameters
-
-##### list
-
-`unknown`
-
-##### predicate
-
-(`item`, `index`, `items`) => `item is T`
+#### isObject
 
-#### Returns
+<a id="api-isobject"></a>
 
-`list is T[]`
-
-***
-
-### isObject()
-
-```ts
-function isObject(obj): obj is object
+```typescript
+isObject: (obj: unknown) => obj is NonNullable<object>
 ```
 
-#### Parameters
+#### isPlainObject
 
-##### obj
+<a id="api-isplainobject"></a>
 
-`unknown`
-
-#### Returns
-
-`obj is object`
+```typescript
+isPlainObject: (obj: unknown) => obj is Record<never, never>
+```
 
-***
+#### isUnaryPredicate
 
-### isPlainObject()
+<a id="api-isunarypredicate"></a>
 
-```ts
-function isPlainObject(obj): obj is Record<never, never>
+```typescript
+isUnaryPredicate: (obj: unknown) => obj is UnaryPredicate<unknown>
 ```
 
-#### Parameters
+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!
 
-##### obj
 
-`unknown`
+### TypeAliases
 
-#### Returns
+#### MessageOrError
 
-`obj is Record<never, never>`
+<a id="api-messageorerror"></a>
 
-***
-
-### isUnaryPredicate()
-
-```ts
-function isUnaryPredicate(obj): obj is UnaryPredicate<unknown>
+```typescript
+type MessageOrError = string | Error | (() => (string | Error));
 ```
 
-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`
+A message, an error, or something which can generate one of those.
 
-#### 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.32"
 	},
 	"description": "Rick Osborne's collection of type guards.",
 	"engines": {
@@ -19,17 +19,26 @@
 		}
 	},
 	"homepage": "https://github.com/rickosborne/es-js-ts",
+	"keywords": [
+		"typescript",
+		"guards",
+		"type guards"
+	],
 	"license": "CC-BY-NC-SA-4.0",
 	"main": "cjs/index.js",
+	"module": "esm/index.js",
 	"name": "@rickosborne/guard",
 	"private": false,
 	"publishConfig": {
 		"access": "public"
 	},
+	"readme": "README.md",
 	"repository": {
 		"directory": "guard",
 		"type": "git",
 		"url": "git+https://github.com/rickosborne/es-js-ts.git"
 	},
-	"version": "2024.12.29"
+	"types": "types/index.d.ts",
+	"typings": "types/index.d.ts",
+	"version": "2024.12.32"
 }

package/types/index.d.ts

@@ -7,3 +7,4 @@ export * from "./ts/is-int.js";
 export * from "./ts/is-list-of.js";
 export * from "./ts/is-object.js";
 export * from "./ts/is-predicate.js";
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC"}

package/types/ts/assert-defined.d.ts

@@ -1,2 +1,3 @@
 import { type MessageOrError } from "./error-from-message.js";
 export declare function assertDefined<T>(value: T, messageOrError: MessageOrError): asserts value is NonNullable<T>;
+//# sourceMappingURL=assert-defined.d.ts.map

package/types/ts/assert-defined.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-defined.d.ts","sourceRoot":"","sources":["../../../ts/assert-defined.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAA2B,MAAM,yBAAyB,CAAC;AAEvF,wBAAgB,aAAa,CAAC,CAAC,EAC9B,KAAK,EAAE,CAAC,EACR,cAAc,EAAE,cAAc,GAC5B,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CAKjC"}

package/types/ts/error-from-message.d.ts

@@ -7,3 +7,4 @@ export type MessageOrError = string | Error | (() => (string | Error));
  * can generate one when needed.
  */
 export declare const errorFromMessageOrError: (messageOrError: MessageOrError, defaultConstructor?: (new (message: string) => Error)) => Error;
+//# sourceMappingURL=error-from-message.d.ts.map

package/types/ts/error-from-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-from-message.d.ts","sourceRoot":"","sources":["../../../ts/error-from-message.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,uBAAuB,mBACnB,cAAc,uBACV,CAAC,KAAK,OAAO,EAAE,MAAM,KAAK,KAAK,CAAC,KAClD,KAcF,CAAC"}

package/types/ts/has-array.d.ts

@@ -12,3 +12,4 @@ export declare function hasArray<Name extends string>(obj: unknown, name: Name,
 export declare function hasArray<Name extends string, Item>(obj: unknown, name: Name, predicate?: (item: unknown, index: number, items: unknown[]) => item is Item): obj is {
     [K in Name]: Item[];
 };
+//# sourceMappingURL=has-array.d.ts.map

package/types/ts/has-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-array.d.ts","sourceRoot":"","sources":["../../../ts/has-array.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,SAAS,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,GAAG,IAAI;KAAG,CAAC,IAAI,IAAI,GAAG,OAAO,EAAE;CAAE,CAAC;AAClI;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI,IAAI,GAAG,GAAG,IAAI;KAAG,CAAC,IAAI,IAAI,GAAG,IAAI,EAAE;CAAE,CAAC"}

package/types/ts/has-number.d.ts

@@ -1 +1,2 @@
 export declare const hasNumber: <Name extends string>(obj: unknown, name: Name) => obj is { [k in Name]: string; };
+//# sourceMappingURL=has-number.d.ts.map

package/types/ts/has-number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-number.d.ts","sourceRoot":"","sources":["../../../ts/has-number.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,GAAI,IAAI,SAAS,MAAM,OAAO,OAAO,QAAQ,IAAI,KAAG,GAAG,IAAI,GAAE,CAAC,IAAI,IAAI,GAAG,MAAM,GAEpG,CAAC"}

package/types/ts/has-own.d.ts

@@ -4,3 +4,4 @@ export declare function hasOwn<Name extends string>(obj: unknown, name: Name): o
 export declare function hasOwn<Name extends string, T>(obj: unknown, name: Name, predicate: (value: unknown) => value is T): obj is {
     [K in Name]: T;
 };
+//# sourceMappingURL=has-own.d.ts.map

package/types/ts/has-own.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-own.d.ts","sourceRoot":"","sources":["../../../ts/has-own.ts"],"names":[],"mappings":"AAEA,wBAAgB,MAAM,CAAC,IAAI,SAAS,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,GAAG,IAAI;KAAE,CAAC,IAAI,IAAI,GAAG,OAAO;CAAC,CAAC;AACrG,wBAAgB,MAAM,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GAAG,GAAG,IAAI;KAAE,CAAC,IAAI,IAAI,GAAG,CAAC;CAAC,CAAC"}

package/types/ts/is-int.d.ts

@@ -2,3 +2,4 @@ import { type MessageOrError } from "./error-from-message.js";
 export declare const isInt: (obj: unknown) => obj is number;
 export declare function assertInt(value: unknown, messageOrError: MessageOrError): asserts value is number;
 export declare const expectInt: (obj: unknown, messageOrError: MessageOrError) => number;
+//# sourceMappingURL=is-int.d.ts.map

package/types/ts/is-int.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-int.d.ts","sourceRoot":"","sources":["../../../ts/is-int.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAA2B,MAAM,yBAAyB,CAAC;AAEvF,eAAO,MAAM,KAAK,QAAS,OAAO,KAAG,GAAG,IAAI,MAAoH,CAAC;AAEjK,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAIjG;AAED,eAAO,MAAM,SAAS,QAChB,OAAO,kBACI,cAAc,KAC5B,MAGF,CAAC"}

package/types/ts/is-list-of.d.ts

@@ -1 +1,2 @@
 export declare const isListOf: <T>(list: unknown, predicate: (item: unknown, index: number, items: unknown[]) => item is T) => list is T[];
+//# sourceMappingURL=is-list-of.d.ts.map

package/types/ts/is-list-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-list-of.d.ts","sourceRoot":"","sources":["../../../ts/is-list-of.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,GAAI,CAAC,QACnB,OAAO,aACF,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,IAAI,CAAC,KACtE,IAAI,IAAI,CAAC,EAEX,CAAC"}

package/types/ts/is-object.d.ts

@@ -1,2 +1,3 @@
 export declare const isObject: (obj: unknown) => obj is NonNullable<object>;
 export declare const isPlainObject: (obj: unknown) => obj is Record<never, never>;
+//# sourceMappingURL=is-object.d.ts.map

package/types/ts/is-object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-object.d.ts","sourceRoot":"","sources":["../../../ts/is-object.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,QAAS,OAAO,KAAG,GAAG,IAAI,WAAW,CAAC,MAAM,CAEhE,CAAC;AAEF,eAAO,MAAM,aAAa,QAAS,OAAO,KAAG,GAAG,IAAI,MAAM,CAAC,KAAK,EAAC,KAAK,CAMrE,CAAC"}

package/types/ts/is-predicate.d.ts

@@ -6,3 +6,4 @@ import { UnaryPredicate } from "@rickosborne/typical";
  * it may not actually act as a predicate!
  */
 export declare const isUnaryPredicate: (obj: unknown) => obj is UnaryPredicate<unknown>;
+//# sourceMappingURL=is-predicate.d.ts.map

package/types/ts/is-predicate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-predicate.d.ts","sourceRoot":"","sources":["../../../ts/is-predicate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,QAAS,OAAO,KAAG,GAAG,IAAI,cAAc,CAAC,OAAO,CAE5E,CAAC"}

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.48.1"
+    }
+  ]
+}