feat(guards): isInt

Signed-off-by: Lexus Drumgold <[email protected]>

src/guards/__tests__/is-int.spec-d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Type Tests - isInt
+ * @module tutils/guards/tests/unit-d/isInt
+ */
+
+import type testSubject from '../is-int'
+
+describe('unit-d:guards/isInt', () => {
+  it('should guard number', () => {
+    expectTypeOf<typeof testSubject>().guards.toBeNumber()
+  })
+})

src/guards/__tests__/is-int.spec.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Unit Tests - isInt
+ * @module tutils/guards/tests/unit/isInt
+ */
+
+import testSubject from '../is-int'
+
+describe('unit:guards/isInt', () => {
+  it('should return false if value is not an integer', () => {
+    expect(testSubject(faker.number.float({ min: 0.13 }))).to.be.false
+  })
+
+  it('should return true if value is an integer', () => {
+    expect(testSubject(faker.number.int())).to.be.true
+  })
+})

src/guards/index.ts

@@ -10,6 +10,7 @@ export { default as isBooleanish } from './is-booleanish'
 export { default as isEmptyString } from './is-empty-string'
 export { default as isEmptyValue } from './is-empty-value'
 export { default as isFloat } from './is-float'
+export { default as isInt } from './is-int'
 export { default as isJwtType } from './is-jwt-type'
 export { default as isNIL } from './is-nil'
 export { default as isNodeEnv } from './is-node-env'

src/guards/is-int.ts

@@ -0,0 +1,18 @@
+/**
+ * @file Type Guards - isInt
+ * @module tutils/guards/isInt
+ */
+
+import isNumber from './is-number'
+
+/**
+ * Checks if the given `value` is an integer.
+ *
+ * @param {unknown} value - Value to evaluate
+ * @return {value is number} `true` if `value` is an integer
+ */
+const isInt = (value: unknown): value is number => {
+  return isNumber(value) && value % 1 === 0
+}
+
+export default isInt