small tweaks

Author: aleclarson

docs/typed/isBigInt.mdx

@@ -1,17 +1,17 @@
 ---
 title: isBigInt
-description: 'Determine if a value is BigInt'
+description: 'Determine if a value is a BigInt'
 ---
 
 ### Usage
 
-Pass in a value and get a boolean telling you if the value is a bigint.
+Pass in a value and get a boolean telling you if the value is a bigint, using the `typeof` operator.
 
 ```ts
 import * as _ from 'radashi'
 
-_.isBigInt('hello') // => false
-_.isBigInt(['hello']) // => false
-_.isBigInt(12) // => false
 _.isBigInt(0n) // => true
+_.isBigInt(BigInt(0)) // => true
+_.isBigInt(12) // => false
+_.isBigInt('0n') // => false
 ```

src/mod.ts

@@ -112,6 +112,7 @@ export * from './string/title.ts'
 export * from './string/trim.ts'
 
 export * from './typed/isArray.ts'
+export * from './typed/isBigInt.ts'
 export * from './typed/isBoolean.ts'
 export * from './typed/isClass.ts'
 export * from './typed/isDate.ts'
@@ -141,6 +142,5 @@ export * from './typed/isTagged.ts'
 export * from './typed/isUndefined.ts'
 export * from './typed/isWeakMap.ts'
 export * from './typed/isWeakSet.ts'
-export * from './typed/isBigInt.ts'
 
 export * from './types.ts'

src/typed/isBigInt.ts

@@ -1,13 +1,13 @@
 /**
- * Return true if the give value is bigint.
+ * Return true if the give value is a BigInt.
  *
  * @see https://radashi.js.org/reference/typed/isBigInt
  * @example
  * ```ts
- * isBigInt('hello') // => false
- * isBigInt(['hello']) // => false
- * isBigInt(12) // => false
- * isBigInt(0n) // => true
+ * _.isBigInt(0n) // => true
+ * _.isBigInt(BigInt(0)) // => true
+ * _.isBigInt(12) // => false
+ * _.isBigInt('0n') // => false
  * ```
  */
 export function isBigInt(value: unknown): value is bigint {

tests/typed/isBigInt.test.ts

@@ -1,57 +1,28 @@
 import * as _ from 'radashi'
 
 describe('isBigInt function', () => {
-  test('returns false for null', () => {
-    const result = _.isBigInt(null)
-    expect(result).toBeFalsy()
-  })
-  test('returns false for undefined', () => {
-    const result = _.isBigInt(undefined)
-    expect(result).toBeFalsy()
-  })
-  test('returns false for boolean', () => {
-    const result = _.isBigInt(false)
-    expect(result).toBeFalsy()
-  })
-  test('returns false for class instance', () => {
+  test('returns false for non-bigint values', () => {
+    // Primitive values
+    expect(_.isBigInt(null)).toBeFalsy()
+    expect(_.isBigInt(undefined)).toBeFalsy()
+    expect(_.isBigInt(false)).toBeFalsy()
+    expect(_.isBigInt(22)).toBeFalsy()
+    expect(_.isBigInt(22.0567)).toBeFalsy()
+    expect(_.isBigInt(Number.NaN)).toBeFalsy()
+    expect(_.isBigInt('0n')).toBeFalsy()
+
+    // Objects and collections
+    expect(_.isBigInt([1, 2, 3])).toBeFalsy()
+    expect(_.isBigInt({})).toBeFalsy()
+    expect(_.isBigInt(String('abc'))).toBeFalsy()
+
+    // Class instance
     class Data {}
-    const result = _.isBigInt(new Data())
-    expect(result).toBeFalsy()
-  })
-  test('returns false for int', () => {
-    const result = _.isBigInt(22)
-    expect(result).toBeFalsy()
-  })
-  test('returns false for float', () => {
-    const result = _.isBigInt(22.0567)
-    assert.isFalse(result)
+    expect(_.isBigInt(new Data())).toBeFalsy()
   })
-  test('returns false for NaN', () => {
-    const result = _.isBigInt(Number.NaN)
-    expect(result).toBeFalsy()
-  })
-  test('returns false for array', () => {
-    const result = _.isBigInt([1, 2, 3])
-    expect(result).toBeFalsy()
-  })
-  test('returns false for object', () => {
-    const result = _.isBigInt({})
-    expect(result).toBeFalsy()
-  })
-  test('returns false for string', () => {
-    const result = _.isBigInt('abc')
-    expect(result).toBeFalsy()
-  })
-  test('returns false for string class', () => {
-    const result = _.isBigInt(String('abc'))
-    expect(result).toBeFalsy()
-  })
-  test('returns true for bigint', () => {
-    const result = _.isBigInt(22n)
-    expect(result).toBeTruthy()
-  })
-  test('returns true for bigint class', () => {
-    const result = _.isBigInt(BigInt(22))
-    expect(result).toBeTruthy()
+
+  test('returns true for bigint values', () => {
+    expect(_.isBigInt(22n)).toBeTruthy()
+    expect(_.isBigInt(BigInt(22))).toBeTruthy()
   })
 })