@jblib/is 0.0.5 → 0.0.6

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/dist/index.d.ts CHANGED
@@ -5,11 +5,14 @@ import { isDefined } from "./is-defined.js";
5
5
  import { isEmptyObject } from "./is-empty-object.js";
6
6
  import { isError } from "./is-error.js";
7
7
  import { isFunction } from "./is-function.js";
8
+ import { isNegativeNumber } from "./is-negative-number.js";
8
9
  import { isNil } from "./is-nil.js";
9
10
  import { isNonEmptyArray } from "./is-non-empty-array.js";
10
11
  import { isNumber } from "./is-number.js";
11
12
  import { isObject } from "./is-object.js";
12
13
  import { isPlainObject } from "./is-plain-object.js";
14
+ import { isPositiveNumber } from "./is-positive-number.js";
13
15
  import { isPrimitive } from "./is-primitive.js";
14
16
  import { isString } from "./is-string.js";
15
- export { isArray, isBoolean, isDate, isDefined, isEmptyObject, isError, isFunction, isNil, isNonEmptyArray, isNumber, isObject, isPlainObject, isPrimitive, isString };
17
+ import { isUndefined } from "./is-undefined.js";
18
+ export { isArray, isBoolean, isDate, isDefined, isEmptyObject, isError, isFunction, isNegativeNumber, isNil, isNonEmptyArray, isNumber, isObject, isPlainObject, isPositiveNumber, isPrimitive, isString, isUndefined };
package/dist/index.js CHANGED
@@ -6,11 +6,14 @@ import { isPlainObject } from "./is-plain-object.js";
6
6
  import { isEmptyObject } from "./is-empty-object.js";
7
7
  import { isError } from "./is-error.js";
8
8
  import { isFunction } from "./is-function.js";
9
+ import { isNegativeNumber } from "./is-negative-number.js";
9
10
  import { isNil } from "./is-nil.js";
10
11
  import { isNonEmptyArray } from "./is-non-empty-array.js";
11
12
  import { isNumber } from "./is-number.js";
12
13
  import { isObject } from "./is-object.js";
14
+ import { isPositiveNumber } from "./is-positive-number.js";
13
15
  import { isPrimitive } from "./is-primitive.js";
14
16
  import { isString } from "./is-string.js";
17
+ import { isUndefined } from "./is-undefined.js";
15
18
 
16
- export { isArray, isBoolean, isDate, isDefined, isEmptyObject, isError, isFunction, isNil, isNonEmptyArray, isNumber, isObject, isPlainObject, isPrimitive, isString };
19
+ export { isArray, isBoolean, isDate, isDefined, isEmptyObject, isError, isFunction, isNegativeNumber, isNil, isNonEmptyArray, isNumber, isObject, isPlainObject, isPositiveNumber, isPrimitive, isString, isUndefined };
@@ -0,0 +1,20 @@
1
+ //#region src/is-negative-number.d.ts
2
+ /**
3
+ * isNegativeNumber checks if a value is a negative number.
4
+ * Note that zero is not considered a negative number.
5
+ *
6
+ * @param v value to check.
7
+ * @returns {v is number} returns true if v is a negative number or otherwise false.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * isNegativeNumber(-5) // true
12
+ * isNegativeNumber(5) // false
13
+ * isNegativeNumber(0) // false
14
+ * isNegativeNumber('hello') // false
15
+ * ```
16
+ */
17
+ declare const isNegativeNumber: (v: unknown) => v is number;
18
+ //#endregion
19
+ export { isNegativeNumber };
20
+ //# sourceMappingURL=is-negative-number.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-negative-number.d.ts","names":[],"sources":["../src/is-negative-number.ts"],"mappings":";;;;;;;;;;;;;;;;cAeM,gBAAA,GAAoB,CAAA,cAAa,CAAA"}
@@ -0,0 +1,23 @@
1
+ //#region src/is-negative-number.ts
2
+ /**
3
+ * isNegativeNumber checks if a value is a negative number.
4
+ * Note that zero is not considered a negative number.
5
+ *
6
+ * @param v value to check.
7
+ * @returns {v is number} returns true if v is a negative number or otherwise false.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * isNegativeNumber(-5) // true
12
+ * isNegativeNumber(5) // false
13
+ * isNegativeNumber(0) // false
14
+ * isNegativeNumber('hello') // false
15
+ * ```
16
+ */
17
+ const isNegativeNumber = (v) => {
18
+ return typeof v === "number" && v < 0;
19
+ };
20
+
21
+ //#endregion
22
+ export { isNegativeNumber };
23
+ //# sourceMappingURL=is-negative-number.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-negative-number.js","names":[],"sources":["../src/is-negative-number.ts"],"sourcesContent":["/**\n * isNegativeNumber checks if a value is a negative number.\n * Note that zero is not considered a negative number.\n *\n * @param v value to check.\n * @returns {v is number} returns true if v is a negative number or otherwise false.\n *\n * @example\n * ```ts\n * isNegativeNumber(-5) // true\n * isNegativeNumber(5) // false\n * isNegativeNumber(0) // false\n * isNegativeNumber('hello') // false\n * ```\n */\nconst isNegativeNumber = (v: unknown): v is number => {\n return typeof v === 'number' && v < 0\n}\n\nexport { isNegativeNumber }\n"],"mappings":";;;;;;;;;;;;;;;;AAeA,MAAM,oBAAoB,MAA4B;AACpD,QAAO,OAAO,MAAM,YAAY,IAAI"}
@@ -0,0 +1,20 @@
1
+ //#region src/is-positive-number.d.ts
2
+ /**
3
+ * isPositiveNumber checks if a value is a positive number.
4
+ * Note that zero is not considered a positive number.
5
+ *
6
+ * @param value value to check.
7
+ * @returns {value is number} returns true if value is a positive number or otherwise false.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * isPositiveNumber(5) // true
12
+ * isPositiveNumber(-5) // false
13
+ * isPositiveNumber(0) // false
14
+ * isPositiveNumber('hello') // false
15
+ * ```
16
+ */
17
+ declare const isPositiveNumber: (value: unknown) => value is number;
18
+ //#endregion
19
+ export { isPositiveNumber };
20
+ //# sourceMappingURL=is-positive-number.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-positive-number.d.ts","names":[],"sources":["../src/is-positive-number.ts"],"mappings":";;;;;;;;;;;;;;;;cAeM,gBAAA,GAAoB,KAAA,cAAiB,KAAA"}
@@ -0,0 +1,23 @@
1
+ //#region src/is-positive-number.ts
2
+ /**
3
+ * isPositiveNumber checks if a value is a positive number.
4
+ * Note that zero is not considered a positive number.
5
+ *
6
+ * @param value value to check.
7
+ * @returns {value is number} returns true if value is a positive number or otherwise false.
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * isPositiveNumber(5) // true
12
+ * isPositiveNumber(-5) // false
13
+ * isPositiveNumber(0) // false
14
+ * isPositiveNumber('hello') // false
15
+ * ```
16
+ */
17
+ const isPositiveNumber = (value) => {
18
+ return typeof value === "number" && value > 0;
19
+ };
20
+
21
+ //#endregion
22
+ export { isPositiveNumber };
23
+ //# sourceMappingURL=is-positive-number.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-positive-number.js","names":[],"sources":["../src/is-positive-number.ts"],"sourcesContent":["/**\n * isPositiveNumber checks if a value is a positive number.\n * Note that zero is not considered a positive number.\n *\n * @param value value to check.\n * @returns {value is number} returns true if value is a positive number or otherwise false.\n *\n * @example\n * ```ts\n * isPositiveNumber(5) // true\n * isPositiveNumber(-5) // false\n * isPositiveNumber(0) // false\n * isPositiveNumber('hello') // false\n * ```\n */\nconst isPositiveNumber = (value: unknown): value is number => {\n return typeof value === 'number' && value > 0\n}\n\nexport { isPositiveNumber }\n"],"mappings":";;;;;;;;;;;;;;;;AAeA,MAAM,oBAAoB,UAAoC;AAC5D,QAAO,OAAO,UAAU,YAAY,QAAQ"}
@@ -0,0 +1,20 @@
1
+ //#region src/is-undefined.d.ts
2
+ /**
3
+ * isUndefined checks if a value is undefined.
4
+ *
5
+ * @param v value to check.
6
+ * @returns {v is undefined} returns true if v is undefined or otherwise false.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * isUndefined(undefined) // true
11
+ * isUndefined('hello') // false
12
+ * isUndefined(123) // false
13
+ * isUndefined({}) // false
14
+ * isUndefined([]) // false
15
+ * ```
16
+ */
17
+ declare const isUndefined: (v: unknown) => v is undefined;
18
+ //#endregion
19
+ export { isUndefined };
20
+ //# sourceMappingURL=is-undefined.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-undefined.d.ts","names":[],"sources":["../src/is-undefined.ts"],"mappings":";;;;;;;;;;;;;;;;cAeM,WAAA,GAAe,CAAA,cAAa,CAAA"}
@@ -0,0 +1,21 @@
1
+ //#region src/is-undefined.ts
2
+ /**
3
+ * isUndefined checks if a value is undefined.
4
+ *
5
+ * @param v value to check.
6
+ * @returns {v is undefined} returns true if v is undefined or otherwise false.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * isUndefined(undefined) // true
11
+ * isUndefined('hello') // false
12
+ * isUndefined(123) // false
13
+ * isUndefined({}) // false
14
+ * isUndefined([]) // false
15
+ * ```
16
+ */
17
+ const isUndefined = (v) => typeof v === "undefined";
18
+
19
+ //#endregion
20
+ export { isUndefined };
21
+ //# sourceMappingURL=is-undefined.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"is-undefined.js","names":[],"sources":["../src/is-undefined.ts"],"sourcesContent":["/**\n * isUndefined checks if a value is undefined.\n *\n * @param v value to check.\n * @returns {v is undefined} returns true if v is undefined or otherwise false.\n *\n * @example\n * ```ts\n * isUndefined(undefined) // true\n * isUndefined('hello') // false\n * isUndefined(123) // false\n * isUndefined({}) // false\n * isUndefined([]) // false\n * ```\n */\nconst isUndefined = (v: unknown): v is undefined => typeof v === 'undefined'\n\nexport { isUndefined }\n"],"mappings":";;;;;;;;;;;;;;;;AAeA,MAAM,eAAe,MAA+B,OAAO,MAAM"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jblib/is",
3
- "version": "0.0.5",
3
+ "version": "0.0.6",
4
4
  "description": "is, condition checks",
5
5
  "type": "module",
6
6
  "devDependencies": {
package/src/index.ts CHANGED
@@ -5,10 +5,13 @@ export { isDefined } from './is-defined.js'
5
5
  export { isEmptyObject } from './is-empty-object.js'
6
6
  export { isError } from './is-error.js'
7
7
  export { isFunction } from './is-function.js'
8
+ export { isNegativeNumber } from './is-negative-number.js'
8
9
  export { isNil } from './is-nil.js'
9
10
  export { isNonEmptyArray } from './is-non-empty-array.js'
10
11
  export { isNumber } from './is-number.js'
11
12
  export { isObject } from './is-object.js'
12
13
  export { isPlainObject } from './is-plain-object.js'
14
+ export { isPositiveNumber } from './is-positive-number.js'
13
15
  export { isPrimitive } from './is-primitive.js'
14
16
  export { isString } from './is-string.js'
17
+ export { isUndefined } from './is-undefined.js'
@@ -0,0 +1,15 @@
1
+ import { describe, expect, it } from 'vitest'
2
+
3
+ import { isNegativeNumber } from './is-negative-number.js'
4
+
5
+ describe('is negative number', () => {
6
+ it('should return true for negative numbers', () => {
7
+ expect(isNegativeNumber(-5)).toBe(true)
8
+ })
9
+
10
+ it('should return false for non-negative numbers', () => {
11
+ expect(isNegativeNumber(5)).toBe(false)
12
+ expect(isNegativeNumber(0)).toBe(false)
13
+ expect(isNegativeNumber('hello')).toBe(false)
14
+ })
15
+ })
@@ -0,0 +1,20 @@
1
+ /**
2
+ * isNegativeNumber checks if a value is a negative number.
3
+ * Note that zero is not considered a negative number.
4
+ *
5
+ * @param v value to check.
6
+ * @returns {v is number} returns true if v is a negative number or otherwise false.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * isNegativeNumber(-5) // true
11
+ * isNegativeNumber(5) // false
12
+ * isNegativeNumber(0) // false
13
+ * isNegativeNumber('hello') // false
14
+ * ```
15
+ */
16
+ const isNegativeNumber = (v: unknown): v is number => {
17
+ return typeof v === 'number' && v < 0
18
+ }
19
+
20
+ export { isNegativeNumber }
@@ -0,0 +1,15 @@
1
+ import { describe, expect, it } from 'vitest'
2
+
3
+ import { isPositiveNumber } from './is-positive-number.js'
4
+
5
+ describe('is positive number', () => {
6
+ it('should return true for positive numbers', () => {
7
+ expect(isPositiveNumber(5)).toBe(true)
8
+ })
9
+
10
+ it('should return false for non-positive numbers', () => {
11
+ expect(isPositiveNumber(-5)).toBe(false)
12
+ expect(isPositiveNumber(0)).toBe(false)
13
+ expect(isPositiveNumber('hello')).toBe(false)
14
+ })
15
+ })
@@ -0,0 +1,20 @@
1
+ /**
2
+ * isPositiveNumber checks if a value is a positive number.
3
+ * Note that zero is not considered a positive number.
4
+ *
5
+ * @param value value to check.
6
+ * @returns {value is number} returns true if value is a positive number or otherwise false.
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * isPositiveNumber(5) // true
11
+ * isPositiveNumber(-5) // false
12
+ * isPositiveNumber(0) // false
13
+ * isPositiveNumber('hello') // false
14
+ * ```
15
+ */
16
+ const isPositiveNumber = (value: unknown): value is number => {
17
+ return typeof value === 'number' && value > 0
18
+ }
19
+
20
+ export { isPositiveNumber }
@@ -0,0 +1,29 @@
1
+ import { describe, expect, it } from 'vitest'
2
+
3
+ import { isUndefined } from './is-undefined.js'
4
+
5
+ describe('is undefined', () => {
6
+ it('should return true for undefined', () => {
7
+ expect(isUndefined(undefined)).toBe(true)
8
+ })
9
+
10
+ it('should return true for a type that could be undefined and is undefined', () => {
11
+ const v: string | undefined = undefined
12
+
13
+ expect(isUndefined(v)).toBe(true)
14
+ })
15
+
16
+ it('should return false for non-undefined values', () => {
17
+ expect(isUndefined(null)).toBe(false)
18
+ expect(isUndefined('hello')).toBe(false)
19
+ expect(isUndefined(123)).toBe(false)
20
+ expect(isUndefined({})).toBe(false)
21
+ expect(isUndefined([])).toBe(false)
22
+ })
23
+
24
+ it('should return false for a type that could be undefined and is not undefined', () => {
25
+ const v: string | undefined = 'hello'
26
+
27
+ expect(isUndefined(v)).toBe(false)
28
+ })
29
+ })
@@ -0,0 +1,18 @@
1
+ /**
2
+ * isUndefined checks if a value is undefined.
3
+ *
4
+ * @param v value to check.
5
+ * @returns {v is undefined} returns true if v is undefined or otherwise false.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * isUndefined(undefined) // true
10
+ * isUndefined('hello') // false
11
+ * isUndefined(123) // false
12
+ * isUndefined({}) // false
13
+ * isUndefined([]) // false
14
+ * ```
15
+ */
16
+ const isUndefined = (v: unknown): v is undefined => typeof v === 'undefined'
17
+
18
+ export { isUndefined }