@rickosborne/guard 2024.12.23 → 2024.12.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/README.md +26 -0
- package/dist/functions/assertDefined.md +31 -0
- package/dist/functions/assertInt.md +27 -0
- package/dist/functions/errorFromMessageOrError.md +30 -0
- package/dist/functions/expectInt.md +27 -0
- package/dist/functions/hasArray.md +77 -0
- package/dist/functions/hasNumber.md +31 -0
- package/dist/functions/hasOwn.md +65 -0
- package/dist/functions/isInt.md +23 -0
- package/dist/functions/isListOf.md +31 -0
- package/dist/functions/isObject.md +23 -0
- package/dist/functions/isPlainObject.md +23 -0
- package/dist/functions/isUnaryPredicate.md +28 -0
- package/dist/type-aliases/MessageOrError.md +15 -0
- package/package.json +4 -2
- package/dist/cjs/index.js +0 -18
- package/dist/cjs/index.js.map +0 -1
- package/dist/cjs/package.json +0 -6
- package/dist/cjs/ts/has-array.js +0 -9
- package/dist/cjs/ts/has-array.js.map +0 -1
- package/dist/cjs/ts/has-number.js +0 -9
- package/dist/cjs/ts/has-number.js.map +0 -1
- package/dist/cjs/ts/has-own.js +0 -11
- package/dist/cjs/ts/has-own.js.map +0 -1
- package/dist/cjs/ts/index.js +0 -23
- package/dist/cjs/ts/index.js.map +0 -1
- package/dist/cjs/ts/is-list-of.js +0 -8
- package/dist/cjs/ts/is-list-of.js.map +0 -1
- package/dist/cjs/ts/is-object.js +0 -16
- package/dist/cjs/ts/is-object.js.map +0 -1
- package/dist/cjs/ts/is-predicate.js +0 -14
- package/dist/cjs/ts/is-predicate.js.map +0 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +0 -1
- package/dist/esm/index.js +0 -2
- package/dist/esm/index.js.map +0 -1
- package/dist/esm/package.json +0 -6
- package/dist/esm/ts/has-array.js +0 -6
- package/dist/esm/ts/has-array.js.map +0 -1
- package/dist/esm/ts/has-number.js +0 -5
- package/dist/esm/ts/has-number.js.map +0 -1
- package/dist/esm/ts/has-own.js +0 -8
- package/dist/esm/ts/has-own.js.map +0 -1
- package/dist/esm/ts/index.js +0 -7
- package/dist/esm/ts/index.js.map +0 -1
- package/dist/esm/ts/is-list-of.js +0 -4
- package/dist/esm/ts/is-list-of.js.map +0 -1
- package/dist/esm/ts/is-object.js +0 -11
- package/dist/esm/ts/is-object.js.map +0 -1
- package/dist/esm/ts/is-predicate.js +0 -10
- package/dist/esm/ts/is-predicate.js.map +0 -1
- package/dist/esm/tsconfig.module.tsbuildinfo +0 -1
- package/dist/types/index.d.ts +0 -1
- package/dist/types/index.js +0 -18
- package/dist/types/index.js.map +0 -1
- package/dist/types/ts/has-array.d.ts +0 -6
- package/dist/types/ts/has-array.js +0 -9
- package/dist/types/ts/has-array.js.map +0 -1
- package/dist/types/ts/has-number.d.ts +0 -1
- package/dist/types/ts/has-number.js +0 -9
- package/dist/types/ts/has-number.js.map +0 -1
- package/dist/types/ts/has-own.d.ts +0 -6
- package/dist/types/ts/has-own.js +0 -11
- package/dist/types/ts/has-own.js.map +0 -1
- package/dist/types/ts/index.d.ts +0 -6
- package/dist/types/ts/index.js +0 -23
- package/dist/types/ts/index.js.map +0 -1
- package/dist/types/ts/is-list-of.d.ts +0 -1
- package/dist/types/ts/is-list-of.js +0 -8
- package/dist/types/ts/is-list-of.js.map +0 -1
- package/dist/types/ts/is-object.d.ts +0 -2
- package/dist/types/ts/is-object.js +0 -16
- package/dist/types/ts/is-object.js.map +0 -1
- package/dist/types/ts/is-predicate.d.ts +0 -8
- package/dist/types/ts/is-predicate.js +0 -14
- package/dist/types/ts/is-predicate.js.map +0 -1
- package/dist/types/tsconfig.types.tsbuildinfo +0 -1
package/README.md
CHANGED
package/dist/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
**@rickosborne/guard v2024.12.27**
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# @rickosborne/guard
|
|
6
|
+
|
|
7
|
+
Basic type guards building on [@rickosborne/typical](https://www.npmjs.com/package/@rickosborne/typical).
|
|
8
|
+
|
|
9
|
+
## Type Aliases
|
|
10
|
+
|
|
11
|
+
- [MessageOrError](type-aliases/MessageOrError.md)
|
|
12
|
+
|
|
13
|
+
## Functions
|
|
14
|
+
|
|
15
|
+
- [assertDefined](functions/assertDefined.md)
|
|
16
|
+
- [assertInt](functions/assertInt.md)
|
|
17
|
+
- [errorFromMessageOrError](functions/errorFromMessageOrError.md)
|
|
18
|
+
- [expectInt](functions/expectInt.md)
|
|
19
|
+
- [hasArray](functions/hasArray.md)
|
|
20
|
+
- [hasNumber](functions/hasNumber.md)
|
|
21
|
+
- [hasOwn](functions/hasOwn.md)
|
|
22
|
+
- [isInt](functions/isInt.md)
|
|
23
|
+
- [isListOf](functions/isListOf.md)
|
|
24
|
+
- [isObject](functions/isObject.md)
|
|
25
|
+
- [isPlainObject](functions/isPlainObject.md)
|
|
26
|
+
- [isUnaryPredicate](functions/isUnaryPredicate.md)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / assertDefined
|
|
6
|
+
|
|
7
|
+
# Function: assertDefined()
|
|
8
|
+
|
|
9
|
+
> **assertDefined**\<`T`\>(`value`, `messageOrError`): `asserts value is NonNullable<T>`
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
• **T**
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### value
|
|
18
|
+
|
|
19
|
+
`T`
|
|
20
|
+
|
|
21
|
+
### messageOrError
|
|
22
|
+
|
|
23
|
+
[`MessageOrError`](../type-aliases/MessageOrError.md)
|
|
24
|
+
|
|
25
|
+
## Returns
|
|
26
|
+
|
|
27
|
+
`asserts value is NonNullable<T>`
|
|
28
|
+
|
|
29
|
+
## Defined in
|
|
30
|
+
|
|
31
|
+
[assert-defined.ts:3](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/assert-defined.ts#L3)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / assertInt
|
|
6
|
+
|
|
7
|
+
# Function: assertInt()
|
|
8
|
+
|
|
9
|
+
> **assertInt**(`value`, `messageOrError`): `asserts value is number`
|
|
10
|
+
|
|
11
|
+
## Parameters
|
|
12
|
+
|
|
13
|
+
### value
|
|
14
|
+
|
|
15
|
+
`unknown`
|
|
16
|
+
|
|
17
|
+
### messageOrError
|
|
18
|
+
|
|
19
|
+
[`MessageOrError`](../type-aliases/MessageOrError.md)
|
|
20
|
+
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`asserts value is number`
|
|
24
|
+
|
|
25
|
+
## Defined in
|
|
26
|
+
|
|
27
|
+
[is-int.ts:5](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-int.ts#L5)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / errorFromMessageOrError
|
|
6
|
+
|
|
7
|
+
# Function: errorFromMessageOrError()
|
|
8
|
+
|
|
9
|
+
> **errorFromMessageOrError**(`messageOrError`, `defaultConstructor`): `Error`
|
|
10
|
+
|
|
11
|
+
Helper for guards which expect text or an error, or
|
|
12
|
+
can generate one when needed.
|
|
13
|
+
|
|
14
|
+
## Parameters
|
|
15
|
+
|
|
16
|
+
### messageOrError
|
|
17
|
+
|
|
18
|
+
[`MessageOrError`](../type-aliases/MessageOrError.md)
|
|
19
|
+
|
|
20
|
+
### defaultConstructor
|
|
21
|
+
|
|
22
|
+
(`message`) => `Error`
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`Error`
|
|
27
|
+
|
|
28
|
+
## Defined in
|
|
29
|
+
|
|
30
|
+
[error-from-message.ts:10](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/error-from-message.ts#L10)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / expectInt
|
|
6
|
+
|
|
7
|
+
# Function: expectInt()
|
|
8
|
+
|
|
9
|
+
> **expectInt**(`obj`, `messageOrError`): `number`
|
|
10
|
+
|
|
11
|
+
## Parameters
|
|
12
|
+
|
|
13
|
+
### obj
|
|
14
|
+
|
|
15
|
+
`unknown`
|
|
16
|
+
|
|
17
|
+
### messageOrError
|
|
18
|
+
|
|
19
|
+
[`MessageOrError`](../type-aliases/MessageOrError.md)
|
|
20
|
+
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`number`
|
|
24
|
+
|
|
25
|
+
## Defined in
|
|
26
|
+
|
|
27
|
+
[is-int.ts:11](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-int.ts#L11)
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / hasArray
|
|
6
|
+
|
|
7
|
+
# Function: hasArray()
|
|
8
|
+
|
|
9
|
+
Guard for whether the given value is an object which has a property with its own array value.
|
|
10
|
+
|
|
11
|
+
## Call Signature
|
|
12
|
+
|
|
13
|
+
> **hasArray**\<`Name`\>(`obj`, `name`, `predicate`?): `obj is { [K in string]: unknown[] }`
|
|
14
|
+
|
|
15
|
+
Guard for whether the given value is an object which has a property with its own array value.
|
|
16
|
+
This variant does not exhaustively check the items of the array.
|
|
17
|
+
|
|
18
|
+
### Type Parameters
|
|
19
|
+
|
|
20
|
+
• **Name** *extends* `string`
|
|
21
|
+
|
|
22
|
+
### Parameters
|
|
23
|
+
|
|
24
|
+
#### obj
|
|
25
|
+
|
|
26
|
+
`unknown`
|
|
27
|
+
|
|
28
|
+
#### name
|
|
29
|
+
|
|
30
|
+
`Name`
|
|
31
|
+
|
|
32
|
+
#### predicate?
|
|
33
|
+
|
|
34
|
+
`undefined`
|
|
35
|
+
|
|
36
|
+
### Returns
|
|
37
|
+
|
|
38
|
+
`obj is { [K in string]: unknown[] }`
|
|
39
|
+
|
|
40
|
+
### Defined in
|
|
41
|
+
|
|
42
|
+
[has-array.ts:8](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/has-array.ts#L8)
|
|
43
|
+
|
|
44
|
+
## Call Signature
|
|
45
|
+
|
|
46
|
+
> **hasArray**\<`Name`, `Item`\>(`obj`, `name`, `predicate`?): `obj is { [K in string]: Item[] }`
|
|
47
|
+
|
|
48
|
+
Guard for whether the given value is an object which has a property with its own array value.
|
|
49
|
+
This variant exhaustively checks the items of the array against the given predicate.
|
|
50
|
+
|
|
51
|
+
### Type Parameters
|
|
52
|
+
|
|
53
|
+
• **Name** *extends* `string`
|
|
54
|
+
|
|
55
|
+
• **Item**
|
|
56
|
+
|
|
57
|
+
### Parameters
|
|
58
|
+
|
|
59
|
+
#### obj
|
|
60
|
+
|
|
61
|
+
`unknown`
|
|
62
|
+
|
|
63
|
+
#### name
|
|
64
|
+
|
|
65
|
+
`Name`
|
|
66
|
+
|
|
67
|
+
#### predicate?
|
|
68
|
+
|
|
69
|
+
(`item`, `index`, `items`) => `item is Item`
|
|
70
|
+
|
|
71
|
+
### Returns
|
|
72
|
+
|
|
73
|
+
`obj is { [K in string]: Item[] }`
|
|
74
|
+
|
|
75
|
+
### Defined in
|
|
76
|
+
|
|
77
|
+
[has-array.ts:13](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/has-array.ts#L13)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / hasNumber
|
|
6
|
+
|
|
7
|
+
# Function: hasNumber()
|
|
8
|
+
|
|
9
|
+
> **hasNumber**\<`Name`\>(`obj`, `name`): `obj is { [k in string]: string }`
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
• **Name** *extends* `string`
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### obj
|
|
18
|
+
|
|
19
|
+
`unknown`
|
|
20
|
+
|
|
21
|
+
### name
|
|
22
|
+
|
|
23
|
+
`Name`
|
|
24
|
+
|
|
25
|
+
## Returns
|
|
26
|
+
|
|
27
|
+
`obj is { [k in string]: string }`
|
|
28
|
+
|
|
29
|
+
## Defined in
|
|
30
|
+
|
|
31
|
+
[has-number.ts:3](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/has-number.ts#L3)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / hasOwn
|
|
6
|
+
|
|
7
|
+
# Function: hasOwn()
|
|
8
|
+
|
|
9
|
+
## Call Signature
|
|
10
|
+
|
|
11
|
+
> **hasOwn**\<`Name`\>(`obj`, `name`): `obj is { [K in string]: unknown }`
|
|
12
|
+
|
|
13
|
+
### Type Parameters
|
|
14
|
+
|
|
15
|
+
• **Name** *extends* `string`
|
|
16
|
+
|
|
17
|
+
### Parameters
|
|
18
|
+
|
|
19
|
+
#### obj
|
|
20
|
+
|
|
21
|
+
`unknown`
|
|
22
|
+
|
|
23
|
+
#### name
|
|
24
|
+
|
|
25
|
+
`Name`
|
|
26
|
+
|
|
27
|
+
### Returns
|
|
28
|
+
|
|
29
|
+
`obj is { [K in string]: unknown }`
|
|
30
|
+
|
|
31
|
+
### Defined in
|
|
32
|
+
|
|
33
|
+
[has-own.ts:3](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/has-own.ts#L3)
|
|
34
|
+
|
|
35
|
+
## Call Signature
|
|
36
|
+
|
|
37
|
+
> **hasOwn**\<`Name`, `T`\>(`obj`, `name`, `predicate`): `obj is { [K in string]: T }`
|
|
38
|
+
|
|
39
|
+
### Type Parameters
|
|
40
|
+
|
|
41
|
+
• **Name** *extends* `string`
|
|
42
|
+
|
|
43
|
+
• **T**
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
#### obj
|
|
48
|
+
|
|
49
|
+
`unknown`
|
|
50
|
+
|
|
51
|
+
#### name
|
|
52
|
+
|
|
53
|
+
`Name`
|
|
54
|
+
|
|
55
|
+
#### predicate
|
|
56
|
+
|
|
57
|
+
(`value`) => `value is T`
|
|
58
|
+
|
|
59
|
+
### Returns
|
|
60
|
+
|
|
61
|
+
`obj is { [K in string]: T }`
|
|
62
|
+
|
|
63
|
+
### Defined in
|
|
64
|
+
|
|
65
|
+
[has-own.ts:4](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/has-own.ts#L4)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / isInt
|
|
6
|
+
|
|
7
|
+
# Function: isInt()
|
|
8
|
+
|
|
9
|
+
> **isInt**(`obj`): `obj is number`
|
|
10
|
+
|
|
11
|
+
## Parameters
|
|
12
|
+
|
|
13
|
+
### obj
|
|
14
|
+
|
|
15
|
+
`unknown`
|
|
16
|
+
|
|
17
|
+
## Returns
|
|
18
|
+
|
|
19
|
+
`obj is number`
|
|
20
|
+
|
|
21
|
+
## Defined in
|
|
22
|
+
|
|
23
|
+
[is-int.ts:3](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-int.ts#L3)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / isListOf
|
|
6
|
+
|
|
7
|
+
# Function: isListOf()
|
|
8
|
+
|
|
9
|
+
> **isListOf**\<`T`\>(`list`, `predicate`): `list is T[]`
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
• **T**
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
### list
|
|
18
|
+
|
|
19
|
+
`unknown`
|
|
20
|
+
|
|
21
|
+
### predicate
|
|
22
|
+
|
|
23
|
+
(`item`, `index`, `items`) => `item is T`
|
|
24
|
+
|
|
25
|
+
## Returns
|
|
26
|
+
|
|
27
|
+
`list is T[]`
|
|
28
|
+
|
|
29
|
+
## Defined in
|
|
30
|
+
|
|
31
|
+
[is-list-of.ts:1](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-list-of.ts#L1)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / isObject
|
|
6
|
+
|
|
7
|
+
# Function: isObject()
|
|
8
|
+
|
|
9
|
+
> **isObject**(`obj`): `obj is object`
|
|
10
|
+
|
|
11
|
+
## Parameters
|
|
12
|
+
|
|
13
|
+
### obj
|
|
14
|
+
|
|
15
|
+
`unknown`
|
|
16
|
+
|
|
17
|
+
## Returns
|
|
18
|
+
|
|
19
|
+
`obj is object`
|
|
20
|
+
|
|
21
|
+
## Defined in
|
|
22
|
+
|
|
23
|
+
[is-object.ts:1](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-object.ts#L1)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / isPlainObject
|
|
6
|
+
|
|
7
|
+
# Function: isPlainObject()
|
|
8
|
+
|
|
9
|
+
> **isPlainObject**(`obj`): `obj is Record<never, never>`
|
|
10
|
+
|
|
11
|
+
## Parameters
|
|
12
|
+
|
|
13
|
+
### obj
|
|
14
|
+
|
|
15
|
+
`unknown`
|
|
16
|
+
|
|
17
|
+
## Returns
|
|
18
|
+
|
|
19
|
+
`obj is Record<never, never>`
|
|
20
|
+
|
|
21
|
+
## Defined in
|
|
22
|
+
|
|
23
|
+
[is-object.ts:5](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-object.ts#L5)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / isUnaryPredicate
|
|
6
|
+
|
|
7
|
+
# Function: isUnaryPredicate()
|
|
8
|
+
|
|
9
|
+
> **isUnaryPredicate**(`obj`): `obj is UnaryPredicate<unknown>`
|
|
10
|
+
|
|
11
|
+
Tests whether the given object is a function and takes at
|
|
12
|
+
least one parameter, and could maybe act as a unary predicate.
|
|
13
|
+
Warning! Since no type information is available at runtime,
|
|
14
|
+
it may not actually act as a predicate!
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### obj
|
|
19
|
+
|
|
20
|
+
`unknown`
|
|
21
|
+
|
|
22
|
+
## Returns
|
|
23
|
+
|
|
24
|
+
`obj is UnaryPredicate<unknown>`
|
|
25
|
+
|
|
26
|
+
## Defined in
|
|
27
|
+
|
|
28
|
+
[is-predicate.ts:9](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/is-predicate.ts#L9)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**@rickosborne/guard v2024.12.27**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rickosborne/guard](../README.md) / MessageOrError
|
|
6
|
+
|
|
7
|
+
# Type Alias: MessageOrError
|
|
8
|
+
|
|
9
|
+
> **MessageOrError**: `string` \| `Error` \| () => `string` \| `Error`
|
|
10
|
+
|
|
11
|
+
A message, an error, or something which can generate one of those.
|
|
12
|
+
|
|
13
|
+
## Defined in
|
|
14
|
+
|
|
15
|
+
[error-from-message.ts:4](https://github.com/rickosborne/es-js-ts/blob/78a07c48a8ee66acad83b938575d051189c41326/guard/ts/error-from-message.ts#L4)
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"url": "https://rickosborne.org"
|
|
5
5
|
},
|
|
6
6
|
"dependencies": {
|
|
7
|
-
"@rickosborne/typical": "
|
|
7
|
+
"@rickosborne/typical": "2024.12.27"
|
|
8
8
|
},
|
|
9
9
|
"description": "Rick Osborne's collection of type guards.",
|
|
10
10
|
"engines": {
|
|
@@ -37,8 +37,10 @@
|
|
|
37
37
|
"build": "tsc -b tsconfig.cjs.json tsconfig.module.json tsconfig.types.json && cp ../static/esm-package.json dist/esm/package.json && cp ../static/cjs-package.json dist/cjs/package.json",
|
|
38
38
|
"check-exports": "tsx ../scripts/check-exports.ts guard",
|
|
39
39
|
"clean": "rm -rf ./dist",
|
|
40
|
+
"doc": "typedoc",
|
|
40
41
|
"lint": "eslint .",
|
|
41
42
|
"lint:fix": "eslint --fix .",
|
|
43
|
+
"postbuild": "npm run doc",
|
|
42
44
|
"prebuild": "npm run clean && npm run type-check",
|
|
43
45
|
"prepub": "npm run prepublish",
|
|
44
46
|
"prepub:dry-run": "npm run prepublish",
|
|
@@ -52,5 +54,5 @@
|
|
|
52
54
|
"type-check": "tsc --noEmit",
|
|
53
55
|
"upgrade:check": "npm-check-updates"
|
|
54
56
|
},
|
|
55
|
-
"version": "2024.12.
|
|
57
|
+
"version": "2024.12.27"
|
|
56
58
|
}
|
package/dist/cjs/index.js
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./ts/index.js"), exports);
|
|
18
|
-
//# sourceMappingURL=index.js.map
|
package/dist/cjs/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}
|
package/dist/cjs/package.json
DELETED
package/dist/cjs/ts/has-array.js
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasArray = hasArray;
|
|
4
|
-
const has_own_js_1 = require("./has-own.js");
|
|
5
|
-
const is_list_of_js_1 = require("./is-list-of.js");
|
|
6
|
-
function hasArray(obj, name, predicate) {
|
|
7
|
-
return (0, has_own_js_1.hasOwn)(obj, name) && (predicate == null || (0, is_list_of_js_1.isListOf)(obj[name], predicate));
|
|
8
|
-
}
|
|
9
|
-
//# sourceMappingURL=has-array.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-array.js","sourceRoot":"","sources":["../../../ts/has-array.ts"],"names":[],"mappings":";;AAKA,4BAEC;AAPD,6CAAsC;AACtC,mDAA2C;AAI3C,SAAgB,QAAQ,CAA4B,GAAY,EAAE,IAAU,EAAE,SAA4E;IACzJ,OAAO,IAAA,mBAAM,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,IAAA,wBAAQ,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AACnF,CAAC"}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasNumber = void 0;
|
|
4
|
-
const has_own_js_1 = require("./has-own.js");
|
|
5
|
-
const hasNumber = (obj, name) => {
|
|
6
|
-
return (0, has_own_js_1.hasOwn)(obj, name) && typeof obj[name] === "number";
|
|
7
|
-
};
|
|
8
|
-
exports.hasNumber = hasNumber;
|
|
9
|
-
//# sourceMappingURL=has-number.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-number.js","sourceRoot":"","sources":["../../../ts/has-number.ts"],"names":[],"mappings":";;;AAAA,6CAAsC;AAE/B,MAAM,SAAS,GAAG,CAAsB,GAAY,EAAE,IAAU,EAAgC,EAAE;IACxG,OAAO,IAAA,mBAAM,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC;AAC3D,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}
|
package/dist/cjs/ts/has-own.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasOwn = hasOwn;
|
|
4
|
-
const is_object_js_1 = require("./is-object.js");
|
|
5
|
-
function hasOwn(obj, name, predicate) {
|
|
6
|
-
if (!(0, is_object_js_1.isObject)(obj) || !Object.hasOwn(obj, name)) {
|
|
7
|
-
return false;
|
|
8
|
-
}
|
|
9
|
-
return predicate == null || predicate(obj[name]);
|
|
10
|
-
}
|
|
11
|
-
//# sourceMappingURL=has-own.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-own.js","sourceRoot":"","sources":["../../../ts/has-own.ts"],"names":[],"mappings":";;AAIA,wBAKC;AATD,iDAA0C;AAI1C,SAAgB,MAAM,CAAyB,GAAY,EAAE,IAAU,EAAE,SAA0C;IAClH,IAAI,CAAC,IAAA,uBAAQ,EAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,IAAwB,CAAC,CAAC,CAAC;AACtE,CAAC"}
|
package/dist/cjs/ts/index.js
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./has-array.js"), exports);
|
|
18
|
-
__exportStar(require("./has-number.js"), exports);
|
|
19
|
-
__exportStar(require("./has-own.js"), exports);
|
|
20
|
-
__exportStar(require("./is-list-of.js"), exports);
|
|
21
|
-
__exportStar(require("./is-object.js"), exports);
|
|
22
|
-
__exportStar(require("./is-predicate.js"), exports);
|
|
23
|
-
//# sourceMappingURL=index.js.map
|
package/dist/cjs/ts/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,kDAAgC;AAChC,+CAA6B;AAC7B,kDAAgC;AAChC,iDAA+B;AAC/B,oDAAkC"}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isListOf = void 0;
|
|
4
|
-
const isListOf = (list, predicate) => {
|
|
5
|
-
return Array.isArray(list) && list.every(predicate);
|
|
6
|
-
};
|
|
7
|
-
exports.isListOf = isListOf;
|
|
8
|
-
//# sourceMappingURL=is-list-of.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-list-of.js","sourceRoot":"","sources":["../../../ts/is-list-of.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CACvB,IAAa,EACb,SAAwE,EAC1D,EAAE;IAChB,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACrD,CAAC,CAAC;AALW,QAAA,QAAQ,YAKnB"}
|
package/dist/cjs/ts/is-object.js
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isPlainObject = exports.isObject = void 0;
|
|
4
|
-
const isObject = (obj) => {
|
|
5
|
-
return obj != null && typeof obj === "object";
|
|
6
|
-
};
|
|
7
|
-
exports.isObject = isObject;
|
|
8
|
-
const isPlainObject = (obj) => {
|
|
9
|
-
if (!(0, exports.isObject)(obj)) {
|
|
10
|
-
return false;
|
|
11
|
-
}
|
|
12
|
-
const proto = Reflect.getPrototypeOf(obj);
|
|
13
|
-
return proto == null || proto === Object.prototype;
|
|
14
|
-
};
|
|
15
|
-
exports.isPlainObject = isPlainObject;
|
|
16
|
-
//# sourceMappingURL=is-object.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-object.js","sourceRoot":"","sources":["../../../ts/is-object.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CAAC,GAAY,EAA8B,EAAE;IACpE,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,QAAQ,YAEnB;AAEK,MAAM,aAAa,GAAG,CAAC,GAAY,EAA8B,EAAE;IACzE,IAAI,CAAC,IAAA,gBAAQ,EAAC,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACpD,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB"}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isUnaryPredicate = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* Tests whether the given object is a function and takes at
|
|
6
|
-
* least one parameter, and could maybe act as a unary predicate.
|
|
7
|
-
* Warning! Since no type information is available at runtime,
|
|
8
|
-
* it may not actually act as a predicate!
|
|
9
|
-
*/
|
|
10
|
-
const isUnaryPredicate = (obj) => {
|
|
11
|
-
return typeof obj === "function" && obj.length >= 1;
|
|
12
|
-
};
|
|
13
|
-
exports.isUnaryPredicate = isUnaryPredicate;
|
|
14
|
-
//# sourceMappingURL=is-predicate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-predicate.js","sourceRoot":"","sources":["../../../ts/is-predicate.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,GAAY,EAAkC,EAAE;IAChF,OAAO,OAAO,GAAG,KAAK,UAAU,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AACrD,CAAC,CAAC;AAFW,QAAA,gBAAgB,oBAE3B"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"root":["../../index.ts","../../ts/has-array.ts","../../ts/has-number.ts","../../ts/has-own.ts","../../ts/index.ts","../../ts/is-list-of.ts","../../ts/is-object.ts","../../ts/is-predicate.ts"],"version":"5.7.2"}
|
package/dist/esm/index.js
DELETED
package/dist/esm/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}
|
package/dist/esm/package.json
DELETED
package/dist/esm/ts/has-array.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-array.js","sourceRoot":"","sources":["../../../ts/has-array.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAI3C,MAAM,UAAU,QAAQ,CAA4B,GAAY,EAAE,IAAU,EAAE,SAA4E;IACzJ,OAAO,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AACnF,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-number.js","sourceRoot":"","sources":["../../../ts/has-number.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,MAAM,CAAC,MAAM,SAAS,GAAG,CAAsB,GAAY,EAAE,IAAU,EAAgC,EAAE;IACxG,OAAO,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC;AAC3D,CAAC,CAAC"}
|
package/dist/esm/ts/has-own.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-own.js","sourceRoot":"","sources":["../../../ts/has-own.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI1C,MAAM,UAAU,MAAM,CAAyB,GAAY,EAAE,IAAU,EAAE,SAA0C;IAClH,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,IAAwB,CAAC,CAAC,CAAC;AACtE,CAAC"}
|
package/dist/esm/ts/index.js
DELETED
package/dist/esm/ts/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-list-of.js","sourceRoot":"","sources":["../../../ts/is-list-of.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG,CACvB,IAAa,EACb,SAAwE,EAC1D,EAAE;IAChB,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACrD,CAAC,CAAC"}
|
package/dist/esm/ts/is-object.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
export const isObject = (obj) => {
|
|
2
|
-
return obj != null && typeof obj === "object";
|
|
3
|
-
};
|
|
4
|
-
export const isPlainObject = (obj) => {
|
|
5
|
-
if (!isObject(obj)) {
|
|
6
|
-
return false;
|
|
7
|
-
}
|
|
8
|
-
const proto = Reflect.getPrototypeOf(obj);
|
|
9
|
-
return proto == null || proto === Object.prototype;
|
|
10
|
-
};
|
|
11
|
-
//# sourceMappingURL=is-object.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-object.js","sourceRoot":"","sources":["../../../ts/is-object.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAY,EAA8B,EAAE;IACpE,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,GAAY,EAA8B,EAAE;IACzE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACpD,CAAC,CAAC"}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Tests whether the given object is a function and takes at
|
|
3
|
-
* least one parameter, and could maybe act as a unary predicate.
|
|
4
|
-
* Warning! Since no type information is available at runtime,
|
|
5
|
-
* it may not actually act as a predicate!
|
|
6
|
-
*/
|
|
7
|
-
export const isUnaryPredicate = (obj) => {
|
|
8
|
-
return typeof obj === "function" && obj.length >= 1;
|
|
9
|
-
};
|
|
10
|
-
//# sourceMappingURL=is-predicate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-predicate.js","sourceRoot":"","sources":["../../../ts/is-predicate.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,GAAY,EAAkC,EAAE;IAChF,OAAO,OAAO,GAAG,KAAK,UAAU,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AACrD,CAAC,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"root":["../../index.ts","../../ts/has-array.ts","../../ts/has-number.ts","../../ts/has-own.ts","../../ts/index.ts","../../ts/is-list-of.ts","../../ts/is-object.ts","../../ts/is-predicate.ts"],"version":"5.7.2"}
|
package/dist/types/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from "./ts/index.js";
|
package/dist/types/index.js
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./ts/index.js"), exports);
|
|
18
|
-
//# sourceMappingURL=index.js.map
|
package/dist/types/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
export declare function hasArray<Name extends string>(obj: unknown, name: Name, predicate?: undefined): obj is {
|
|
2
|
-
[K in Name]: unknown[];
|
|
3
|
-
};
|
|
4
|
-
export declare function hasArray<Name extends string, Item>(obj: unknown, name: Name, predicate?: (item: unknown, index: number, items: unknown[]) => item is Item): obj is {
|
|
5
|
-
[K in Name]: Item[];
|
|
6
|
-
};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasArray = hasArray;
|
|
4
|
-
const has_own_js_1 = require("./has-own.js");
|
|
5
|
-
const is_list_of_js_1 = require("./is-list-of.js");
|
|
6
|
-
function hasArray(obj, name, predicate) {
|
|
7
|
-
return (0, has_own_js_1.hasOwn)(obj, name) && (predicate == null || (0, is_list_of_js_1.isListOf)(obj[name], predicate));
|
|
8
|
-
}
|
|
9
|
-
//# sourceMappingURL=has-array.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-array.js","sourceRoot":"","sources":["../../../ts/has-array.ts"],"names":[],"mappings":";;AAKA,4BAEC;AAPD,6CAAsC;AACtC,mDAA2C;AAI3C,SAAgB,QAAQ,CAA4B,GAAY,EAAE,IAAU,EAAE,SAA4E;IACzJ,OAAO,IAAA,mBAAM,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,IAAI,IAAA,wBAAQ,EAAC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AACnF,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const hasNumber: <Name extends string>(obj: unknown, name: Name) => obj is { [k in Name]: string; };
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasNumber = void 0;
|
|
4
|
-
const has_own_js_1 = require("./has-own.js");
|
|
5
|
-
const hasNumber = (obj, name) => {
|
|
6
|
-
return (0, has_own_js_1.hasOwn)(obj, name) && typeof obj[name] === "number";
|
|
7
|
-
};
|
|
8
|
-
exports.hasNumber = hasNumber;
|
|
9
|
-
//# sourceMappingURL=has-number.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-number.js","sourceRoot":"","sources":["../../../ts/has-number.ts"],"names":[],"mappings":";;;AAAA,6CAAsC;AAE/B,MAAM,SAAS,GAAG,CAAsB,GAAY,EAAE,IAAU,EAAgC,EAAE;IACxG,OAAO,IAAA,mBAAM,EAAC,GAAG,EAAE,IAAI,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC;AAC3D,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
export declare function hasOwn<Name extends string>(obj: unknown, name: Name): obj is {
|
|
2
|
-
[K in Name]: unknown;
|
|
3
|
-
};
|
|
4
|
-
export declare function hasOwn<Name extends string, T>(obj: unknown, name: Name, predicate: (value: unknown) => value is T): obj is {
|
|
5
|
-
[K in Name]: T;
|
|
6
|
-
};
|
package/dist/types/ts/has-own.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hasOwn = hasOwn;
|
|
4
|
-
const is_object_js_1 = require("./is-object.js");
|
|
5
|
-
function hasOwn(obj, name, predicate) {
|
|
6
|
-
if (!(0, is_object_js_1.isObject)(obj) || !Object.hasOwn(obj, name)) {
|
|
7
|
-
return false;
|
|
8
|
-
}
|
|
9
|
-
return predicate == null || predicate(obj[name]);
|
|
10
|
-
}
|
|
11
|
-
//# sourceMappingURL=has-own.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"has-own.js","sourceRoot":"","sources":["../../../ts/has-own.ts"],"names":[],"mappings":";;AAIA,wBAKC;AATD,iDAA0C;AAI1C,SAAgB,MAAM,CAAyB,GAAY,EAAE,IAAU,EAAE,SAA0C;IAClH,IAAI,CAAC,IAAA,uBAAQ,EAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,SAAS,IAAI,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,IAAwB,CAAC,CAAC,CAAC;AACtE,CAAC"}
|
package/dist/types/ts/index.d.ts
DELETED
package/dist/types/ts/index.js
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./has-array.js"), exports);
|
|
18
|
-
__exportStar(require("./has-number.js"), exports);
|
|
19
|
-
__exportStar(require("./has-own.js"), exports);
|
|
20
|
-
__exportStar(require("./is-list-of.js"), exports);
|
|
21
|
-
__exportStar(require("./is-object.js"), exports);
|
|
22
|
-
__exportStar(require("./is-predicate.js"), exports);
|
|
23
|
-
//# sourceMappingURL=index.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,kDAAgC;AAChC,+CAA6B;AAC7B,kDAAgC;AAChC,iDAA+B;AAC/B,oDAAkC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const isListOf: <T>(list: unknown, predicate: (item: unknown, index: number, items: unknown[]) => item is T) => list is T[];
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isListOf = void 0;
|
|
4
|
-
const isListOf = (list, predicate) => {
|
|
5
|
-
return Array.isArray(list) && list.every(predicate);
|
|
6
|
-
};
|
|
7
|
-
exports.isListOf = isListOf;
|
|
8
|
-
//# sourceMappingURL=is-list-of.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-list-of.js","sourceRoot":"","sources":["../../../ts/is-list-of.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CACvB,IAAa,EACb,SAAwE,EAC1D,EAAE;IAChB,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;AACrD,CAAC,CAAC;AALW,QAAA,QAAQ,YAKnB"}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isPlainObject = exports.isObject = void 0;
|
|
4
|
-
const isObject = (obj) => {
|
|
5
|
-
return obj != null && typeof obj === "object";
|
|
6
|
-
};
|
|
7
|
-
exports.isObject = isObject;
|
|
8
|
-
const isPlainObject = (obj) => {
|
|
9
|
-
if (!(0, exports.isObject)(obj)) {
|
|
10
|
-
return false;
|
|
11
|
-
}
|
|
12
|
-
const proto = Reflect.getPrototypeOf(obj);
|
|
13
|
-
return proto == null || proto === Object.prototype;
|
|
14
|
-
};
|
|
15
|
-
exports.isPlainObject = isPlainObject;
|
|
16
|
-
//# sourceMappingURL=is-object.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-object.js","sourceRoot":"","sources":["../../../ts/is-object.ts"],"names":[],"mappings":";;;AAAO,MAAM,QAAQ,GAAG,CAAC,GAAY,EAA8B,EAAE;IACpE,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,QAAQ,YAEnB;AAEK,MAAM,aAAa,GAAG,CAAC,GAAY,EAA8B,EAAE;IACzE,IAAI,CAAC,IAAA,gBAAQ,EAAC,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACpD,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB"}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { UnaryPredicate } from "@rickosborne/typical";
|
|
2
|
-
/**
|
|
3
|
-
* Tests whether the given object is a function and takes at
|
|
4
|
-
* least one parameter, and could maybe act as a unary predicate.
|
|
5
|
-
* Warning! Since no type information is available at runtime,
|
|
6
|
-
* it may not actually act as a predicate!
|
|
7
|
-
*/
|
|
8
|
-
export declare const isUnaryPredicate: (obj: unknown) => obj is UnaryPredicate<unknown>;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isUnaryPredicate = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* Tests whether the given object is a function and takes at
|
|
6
|
-
* least one parameter, and could maybe act as a unary predicate.
|
|
7
|
-
* Warning! Since no type information is available at runtime,
|
|
8
|
-
* it may not actually act as a predicate!
|
|
9
|
-
*/
|
|
10
|
-
const isUnaryPredicate = (obj) => {
|
|
11
|
-
return typeof obj === "function" && obj.length >= 1;
|
|
12
|
-
};
|
|
13
|
-
exports.isUnaryPredicate = isUnaryPredicate;
|
|
14
|
-
//# sourceMappingURL=is-predicate.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"is-predicate.js","sourceRoot":"","sources":["../../../ts/is-predicate.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACI,MAAM,gBAAgB,GAAG,CAAC,GAAY,EAAkC,EAAE;IAChF,OAAO,OAAO,GAAG,KAAK,UAAU,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;AACrD,CAAC,CAAC;AAFW,QAAA,gBAAgB,oBAE3B"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"root":["../../index.ts","../../ts/has-array.ts","../../ts/has-number.ts","../../ts/has-own.ts","../../ts/index.ts","../../ts/is-list-of.ts","../../ts/is-object.ts","../../ts/is-predicate.ts"],"version":"5.7.2"}
|