BigInt helpers and Forbid type

CHANGELOG.md

@@ -1,5 +1,11 @@
 # deverything
 
+## 1.8.0
+
+### Minor Changes
+
+- BigInt helpers and Forbid type
+
 ## 1.7.0
 
 ### Minor Changes

README.md

@@ -184,26 +184,29 @@ These functions are optimized for low entropy random data generation useful for
 - `Coords`
 - `DateLike`
 - `Dimensions`
+- `HashMap<>`
+  - `BoolMap`
+  - `NumberMap`
+  - `StringMap`
+  - `TrueMap`
+- `Forbid<>`
+- `Key`
 - `Maybe<>`
   - `MaybePromise<>`
   - `MaybePromiseOrValue<>`
   - `MaybePromiseOrValueArray<>`
 - `NonUndefined`
-- `Key`
+- `ObjectEntries<>`
+- `ObjectEntry<>`
 - `ObjectKey<>`
 - `ObjectKeys<>`
 - `ObjectValue<>`
 - `ObjectValues<>`
-- `ObjectEntry<>`
-- `ObjectEntries<>`
 - ⭐ `PlainObject` use this instead of `Record<,>` or `extends object`, also makes sure it's not an array
+- `PickRequired<>`
 - `PlainKey`
 - `Point`
-- `HashMap<>`
-  - `BoolMap`
-  - `NumberMap`
-  - `StringMap`
-  - `TrueMap`
+- `Required<>`
 - `VoidFn`
 
 ## Development

package.json

@@ -1,6 +1,6 @@
 {
   "name": "deverything",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "Everything you need for Dev",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/constants/numbers.ts

@@ -0,0 +1,2 @@
+export const INT4_MAX = 2147483647;
+export const INT4_MIN = -INT4_MAX;

src/types/Date.ts

@@ -9,6 +9,14 @@ export type ISODate = string;
  * @example "2021-01-01"
  */
 export type ISODay = string;
+/**
+ * @example "2021-01"
+ */
+export type ISOMonth = string;
+/**
+ * @example "2021"
+ */
+export type ISOYear = string;
 /**
  * @example "America/New_York"
  */

src/types/Required.ts

@@ -3,3 +3,7 @@ export type Required<T> = {
 };
 
 export type PickRequired<T, K extends keyof T> = Required<Pick<T, K>>;
+
+export type Forbid<T, K extends keyof any> = {
+  [P in keyof T]: P extends K ? never : T[P];
+};

src/types/index.ts

@@ -11,4 +11,3 @@ export * from "./Point";
 export * from "./PrismaSelect";
 export * from "./Required";
 export * from "./Serialized";
-export * from "./WithDatey";

src/validators/isNumber.test.ts

@@ -1,10 +1,13 @@
 import { expect, it, describe } from "@jest/globals";
 import {
+  isBigInt,
+  isBigIntString,
   isEven,
   isInt,
   isNegativeInt,
   isNumber,
   isOdd,
+  isOutsideInt4,
   isPositiveInt,
 } from "./isNumber";
 
@@ -98,4 +101,44 @@ describe("isNumber", function () {
       expect(isNegativeInt("0" as unknown as number)).toBe(false);
     });
   });
+
+  describe("isBigInt", function () {
+    it("checks true", function () {
+      expect(isBigInt(BigInt(12345678901234567890))).toBe(true);
+      expect(isBigInt(1n)).toBe(true);
+      expect(isBigInt(0n)).toBe(true);
+    });
+
+    it("checks false", function () {
+      expect(isBigInt(Number.MAX_SAFE_INTEGER)).toBe(false);
+      expect(isBigInt(Number.MAX_SAFE_INTEGER + 1)).toBe(false); // ???
+      expect(isBigInt(1)).toBe(false);
+      expect(isBigInt(0)).toBe(false);
+    });
+  });
+});
+
+describe("isBigIntString", function () {
+  it("checks true", function () {
+    expect(isBigIntString("12345678901234567890")).toBe(true);
+  });
+
+  it("checks false", function () {
+    expect(isBigIntString(Number.MAX_SAFE_INTEGER.toString())).toBe(false);
+    expect(isBigIntString("1")).toBe(false);
+  });
+});
+
+describe("isOutsideInt4", function () {
+  it("checks true", function () {
+    expect(isOutsideInt4(12345678901234567890)).toBe(true);
+    expect(isOutsideInt4(-12345678901234567890)).toBe(true);
+  });
+
+  it("checks false", function () {
+    expect(isOutsideInt4(Number.MAX_SAFE_INTEGER)).toBe(false);
+    expect(isOutsideInt4(1)).toBe(false);
+    expect(isOutsideInt4(0)).toBe(false);
+    expect(isOutsideInt4(12345678901234567890 / 10e9)).toBe(false);
+  });
 });

src/validators/isNumber.ts

@@ -1,3 +1,6 @@
+import { INT4_MAX, INT4_MIN } from "../constants/numbers";
+import { isOutside } from "../math/isOutside";
+
 export const isInt = (arg: any) => Number.isInteger(arg);
 
 export const isEven = (arg: any) => isInt(arg) && !(arg % 2);
@@ -23,3 +26,19 @@ export const isNumber = (arg: any): arg is number => {
     Object.prototype.toString.apply(arg) === "[object Number]" && isFinite(arg)
   );
 };
+
+export const isBigInt = (arg: any): arg is BigInt => {
+  return Object.prototype.toString.apply(arg) === "[object BigInt]";
+};
+
+export const isBigIntString = (arg: string): boolean => {
+  try {
+    return BigInt(arg) > Number.MAX_SAFE_INTEGER;
+  } catch (e) {
+    return false;
+  }
+};
+
+export const isOutsideInt4 = (num: number): boolean => {
+  return isOutside(num, INT4_MIN, INT4_MAX);
+};

tsconfig.json

@@ -6,7 +6,7 @@
   "compilerOptions": {
     "lib": ["dom", "dom.iterable", "esnext"],
     "types": ["node"],
-    "target": "es6",
+    "target": "ES2020",
     "composite": false,
     "declaration": true,
     "declarationMap": true,