@jblib/is 0.0.2 → 0.0.3

package/dist/is-number.d.ts

@@ -1,9 +1,16 @@
 //#region src/is-number.d.ts
 /**
- * Checks if a value is a number.
+ * isNumber checks if the provided value is a number.
  *
- * @param v value to check
- * @returns boolean indicating if the value is a number
+ * @param v value to check.
+ * @returns {v is number} returns true if v is a number or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isNumber(123) // true
+ * isNumber('hello') // false
+ * isNumber({}) // false
+ * ```
  */
 declare const isNumber: (v: unknown) => v is number;
 //#endregion

package/dist/is-number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-number.d.ts","names":[],"sources":["../src/is-number.ts"],"mappings":";;;;;;;cAMM,QAAA,GAAY,CAAA,cAAa,CAAA"}
+{"version":3,"file":"is-number.d.ts","names":[],"sources":["../src/is-number.ts"],"mappings":";;;;;;;;;;;;;;cAaM,QAAA,GAAY,CAAA,cAAa,CAAA"}

package/dist/is-number.js

@@ -1,9 +1,16 @@
 //#region src/is-number.ts
 /**
-* Checks if a value is a number.
+* isNumber checks if the provided value is a number.
 *
-* @param v value to check
-* @returns boolean indicating if the value is a number
+* @param v value to check.
+* @returns {v is number} returns true if v is a number or otherwise false.
+*
+* @example
+* ```ts
+* isNumber(123) // true
+* isNumber('hello') // false
+* isNumber({}) // false
+* ```
 */
 const isNumber = (v) => typeof v === "number";
 

package/dist/is-number.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-number.js","names":[],"sources":["../src/is-number.ts"],"sourcesContent":["/**\n * Checks if a value is a number.\n *\n * @param v value to check\n * @returns boolean indicating if the value is a number\n */\nconst isNumber = (v: unknown): v is number => typeof v === 'number'\n\nexport { isNumber }\n"],"mappings":";;;;;;;AAMA,MAAM,YAAY,MAA4B,OAAO,MAAM"}
+{"version":3,"file":"is-number.js","names":[],"sources":["../src/is-number.ts"],"sourcesContent":["/**\n * isNumber checks if the provided value is a number.\n *\n * @param v value to check.\n * @returns {v is number} returns true if v is a number or otherwise false.\n *\n * @example\n * ```ts\n * isNumber(123) // true\n * isNumber('hello') // false\n * isNumber({}) // false\n * ```\n */\nconst isNumber = (v: unknown): v is number => typeof v === 'number'\n\nexport { isNumber }\n"],"mappings":";;;;;;;;;;;;;;AAaA,MAAM,YAAY,MAA4B,OAAO,MAAM"}

package/dist/is-string.d.ts

@@ -1,9 +1,16 @@
 //#region src/is-string.d.ts
 /**
- * Checks if a value is a string.
+ * isString checks if the provided value is a string.
  *
- * @param v value to check
- * @returns boolean indicating if the value is a string
+ * @param v value to check.
+ * @returns {v is string} returns true if v is a string or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isString('hello') // true
+ * isString(123) // false
+ * isString({}) // false
+ * ```
  */
 declare const isString: (v: unknown) => v is string;
 //#endregion

package/dist/is-string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-string.d.ts","names":[],"sources":["../src/is-string.ts"],"mappings":";;;;;;;cAMM,QAAA,GAAY,CAAA,cAAa,CAAA"}
+{"version":3,"file":"is-string.d.ts","names":[],"sources":["../src/is-string.ts"],"mappings":";;;;;;;;;;;;;;cAaM,QAAA,GAAY,CAAA,cAAa,CAAA"}

package/dist/is-string.js

@@ -1,9 +1,16 @@
 //#region src/is-string.ts
 /**
-* Checks if a value is a string.
+* isString checks if the provided value is a string.
 *
-* @param v value to check
-* @returns boolean indicating if the value is a string
+* @param v value to check.
+* @returns {v is string} returns true if v is a string or otherwise false.
+*
+* @example
+* ```ts
+* isString('hello') // true
+* isString(123) // false
+* isString({}) // false
+* ```
 */
 const isString = (v) => typeof v === "string";
 

package/dist/is-string.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-string.js","names":[],"sources":["../src/is-string.ts"],"sourcesContent":["/**\n * Checks if a value is a string.\n *\n * @param v value to check\n * @returns boolean indicating if the value is a string\n */\nconst isString = (v: unknown): v is string => typeof v === 'string'\n\nexport { isString }\n"],"mappings":";;;;;;;AAMA,MAAM,YAAY,MAA4B,OAAO,MAAM"}
+{"version":3,"file":"is-string.js","names":[],"sources":["../src/is-string.ts"],"sourcesContent":["/**\n * isString checks if the provided value is a string.\n *\n * @param v value to check.\n * @returns {v is string} returns true if v is a string or otherwise false.\n *\n * @example\n * ```ts\n * isString('hello') // true\n * isString(123) // false\n * isString({}) // false\n * ```\n */\nconst isString = (v: unknown): v is string => typeof v === 'string'\n\nexport { isString }\n"],"mappings":";;;;;;;;;;;;;;AAaA,MAAM,YAAY,MAA4B,OAAO,MAAM"}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@jblib/is",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "is, condition checks",
   "type": "module",
   "devDependencies": {
-    "vitest": "^4.1.5",
-    "typescript": "^6.0.3",
     "prettier": "^3.8.3",
     "tsdown": "^0.21.10",
-    "@jblib/eslint": "0.0.1"
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5",
+    "@jblib/eslint": "0.0.4"
   },
   "keywords": [
     "is"

package/src/is-array.spec.ts

@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest'
+
+import { isArray } from './is-array.js'
+
+describe('is array', () => {
+  it('should return true for arrays', () => {
+    expect(isArray([])).toBe(true)
+    expect(isArray([1, 2, 3])).toBe(true)
+  })
+
+  it('should return false for non-arrays', () => {
+    expect(isArray('hello')).toBe(false)
+    expect(isArray({})).toBe(false)
+    expect(isArray(123)).toBe(false)
+    expect(isArray(null)).toBe(false)
+    expect(isArray(undefined)).toBe(false)
+  })
+})

package/src/is-array.ts

@@ -0,0 +1,19 @@
+/**
+ * isArray checks if the provided value is an array.
+ *
+ * @param v value to check.
+ * @returns {v is unknown[]} returns true if the value is an array or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isArray([]) // true
+ * isArray([1, 2, 3]) // true
+ * isArray('hello') // false
+ * isArray({}) // false
+ * isArray(123) // false
+ * isArray(undefined) // false
+ * ```
+ */
+const isArray = (v: unknown): v is unknown[] => Array.isArray(v)
+
+export { isArray }

package/src/is-function.spec.ts

@@ -0,0 +1,35 @@
+import { describe, expect, it } from 'vitest'
+
+import { isFunction } from './is-function.js'
+
+describe('is function', () => {
+  it('should return true for functions', () => {
+    expect(
+      isFunction(() => {
+        void 0
+      }),
+    ).toBe(true)
+
+    expect(
+      isFunction(function () {
+        void 0
+      }),
+    ).toBe(true)
+
+    expect(
+      // eslint-disable-next-line @typescript-eslint/require-await
+      isFunction(async function () {
+        void 0
+      }),
+    ).toBe(true)
+  })
+
+  it('should return false for non-functions', () => {
+    expect(isFunction('hello')).toBe(false)
+    expect(isFunction({})).toBe(false)
+    expect(isFunction(123)).toBe(false)
+    expect(isFunction(null)).toBe(false)
+    expect(isFunction(undefined)).toBe(false)
+    expect(isFunction([])).toBe(false)
+  })
+})

package/src/is-function.ts

@@ -0,0 +1,18 @@
+/**
+ * isFunction checks if the provided value is a function.
+ *
+ * @param v value to check.
+ * @returns {v is (...args: unknown[]) => unknown} returns true if v is a function or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isFunction(() => {}) // true
+ * isFunction(function() {}) // true
+ * isFunction(async function() {}) // true
+ * isFunction('hello') // false
+ * isFunction({}) // false
+ * ```
+ */
+const isFunction = (v: unknown): v is (...args: unknown[]) => unknown => typeof v === 'function'
+
+export { isFunction }

package/src/is-non-empty-array.spec.ts

@@ -0,0 +1,21 @@
+import { describe, expect, it } from 'vitest'
+
+import { isNonEmptyArray } from './is-non-empty-array.js'
+
+describe('is non empty array', () => {
+  it('should return true for non-empty arrays', () => {
+    expect(isNonEmptyArray([1, 2, 3])).toBe(true)
+  })
+
+  it('should return false for empty arrays', () => {
+    expect(isNonEmptyArray([])).toBe(false)
+  })
+
+  it('should return false for non-arrays', () => {
+    expect(isNonEmptyArray('hello')).toBe(false)
+    expect(isNonEmptyArray({})).toBe(false)
+    expect(isNonEmptyArray(123)).toBe(false)
+    expect(isNonEmptyArray(null)).toBe(false)
+    expect(isNonEmptyArray(undefined)).toBe(false)
+  })
+})

package/src/is-non-empty-array.ts

@@ -0,0 +1,17 @@
+/**
+ * isNonEmptyArray checks if the provided value is an array and contains at least one element.
+ *
+ * @param v value to check.
+ * @returns {v is unknown[]} returns true if v is a non-empty array or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isNonEmptyArray([1, 2, 3]) // true
+ * isNonEmptyArray([]) // false
+ * isNonEmptyArray('hello') // false
+ * isNonEmptyArray({}) // false
+ * ```
+ */
+const isNonEmptyArray = (v: unknown): v is unknown[] => Array.isArray(v) && v.length > 0
+
+export { isNonEmptyArray }

package/src/is-number.ts

@@ -1,8 +1,15 @@
 /**
- * Checks if a value is a number.
+ * isNumber checks if the provided value is a number.
  *
- * @param v value to check
- * @returns boolean indicating if the value is a number
+ * @param v value to check.
+ * @returns {v is number} returns true if v is a number or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isNumber(123) // true
+ * isNumber('hello') // false
+ * isNumber({}) // false
+ * ```
  */
 const isNumber = (v: unknown): v is number => typeof v === 'number'
 

package/src/is-string.ts

@@ -1,8 +1,15 @@
 /**
- * Checks if a value is a string.
+ * isString checks if the provided value is a string.
  *
- * @param v value to check
- * @returns boolean indicating if the value is a string
+ * @param v value to check.
+ * @returns {v is string} returns true if v is a string or otherwise false.
+ *
+ * @example
+ * ```ts
+ * isString('hello') // true
+ * isString(123) // false
+ * isString({}) // false
+ * ```
  */
 const isString = (v: unknown): v is string => typeof v === 'string'