add runtime type-checker for bigint

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Change Log
 
+- Added runtime type-checker for BigInt.
+
 ## 0.67.0
 
 - Big speedup in certain cases (when many mutations are done between `getSnapshot` calls) by delaying the immutable object creation to the point when `getSnapshot` is called.

packages/lib/src/types/primitiveBased/primitives.ts

@@ -138,6 +138,33 @@ registerStandardTypeResolver((v) => (v === Number ? typesNumber : undefined))
  */
 export class NumberTypeInfo extends TypeInfo {}
 
+/**
+ * A type that represents any BigInt value.
+ *
+ * ```ts
+ * types.bigint
+ * ```
+ */
+ export const typesBigInt: IdentityType<bigint> = new TypeChecker(
+  TypeCheckerBaseType.Primitive,
+
+  (value, path) => (typeof value === "bigint" ? null : new TypeCheckError(path, "bigint", value)),
+
+  () => "bigint",
+  (t) => new BigIntTypeInfo(t),
+
+  (value) => (typeof value === "bigint" ? (typesBigInt as any) : null),
+  identityFn,
+  identityFn
+) as any
+
+registerStandardTypeResolver((v) => (v === BigInt ? typesBigInt : undefined))
+
+/**
+ * `types.bigint` type info.
+ */
+export class BigIntTypeInfo extends TypeInfo {}
+
 /**
  * A type that represents any string value.
  *

packages/lib/src/types/schemas.ts

@@ -74,6 +74,7 @@ export type AnyNonValueType =
   | ModelClass<AnyModel>
   | StringConstructor
   | NumberConstructor
+  | BigIntConstructor
   | BooleanConstructor
   | AnyStandardType
 
@@ -94,6 +95,9 @@ export type TypeToData<S> = S extends ObjectTypeFunction
   : // Number
   S extends NumberConstructor
   ? number
+  : // BigInt
+  S extends BigIntConstructor
+  ? bigint
   : // Boolean
   S extends BooleanConstructor
   ? boolean

packages/lib/src/types/types.ts

@@ -15,10 +15,12 @@ import { RecordTypeInfo, typesRecord } from "./objectBased/record"
 import { RefTypeInfo, typesRef } from "./objectBased/ref"
 import { typesEnum } from "./primitiveBased/enum"
 import {
+  BigIntTypeInfo,
   BooleanTypeInfo,
   LiteralTypeInfo,
   NumberTypeInfo,
   StringTypeInfo,
+  typesBigInt,
   typesBoolean,
   typesLiteral,
   typesNull,
@@ -36,6 +38,7 @@ export { getTypeInfo } from "./getTypeInfo"
 export { TypeInfo } from "./TypeChecker"
 export type { ObjectTypeInfoProps, ModelTypeInfoProps }
 export {
+  BigIntTypeInfo,
   BooleanTypeInfo,
   LiteralTypeInfo,
   NumberTypeInfo,
@@ -60,6 +63,7 @@ export const types = {
   null: typesNull,
   boolean: typesBoolean,
   number: typesNumber,
+  bigint: typesBigInt,
   string: typesString,
   or: typesOr,
   maybe: typesMaybe,

packages/lib/test/types/typeChecking.test.ts

@@ -8,6 +8,7 @@ import {
   arraySet,
   ArraySetTypeInfo,
   ArrayTypeInfo,
+  BigIntTypeInfo,
   BooleanTypeInfo,
   customRef,
   Frozen,
@@ -222,6 +223,26 @@ test("simple number", () => {
   expectValidTypeInfo(type, NumberTypeInfo)
 })
 
+test("bigint", () => {
+  const type = types.bigint
+  assert(_ as TypeToData<typeof type>, _ as bigint)
+
+  expectTypeCheckOk(type, 6n)
+  expectTypeCheckFail(type, "ho", [], "bigint")
+
+  expectValidTypeInfo(type, BigIntTypeInfo)
+})
+
+test("simple bigint", () => {
+  const type = BigInt
+  assert(_ as TypeToData<typeof type>, _ as bigint)
+
+  expectTypeCheckOk(type, 6n)
+  expectTypeCheckFail(type, "ho", [], "bigint")
+
+  expectValidTypeInfo(type, BigIntTypeInfo)
+})
+
 test("string", () => {
   const type = types.string
   assert(_ as TypeToData<typeof type>, _ as string)

packages/site/docs/runtimeTypeChecking.mdx

@@ -99,6 +99,10 @@ A type that represents any number value.
 
 A type that represents any integer number value.
 
+### `types.bigint` / `BigInt`
+
+A type that represents any BigInt value.
+
 ### `types.string` / `String`
 
 A type that represents any string value.