Merge pull request #1164 from fabian-hiller/feat-bigint-multiple-of

Add support for bigints to multipleOf validation action

Author: fabian-hiller

library/CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to the library will be documented in this file.
 - Add `summarize` method to summarize issues into a pretty-printable multi-line string (pull request #1158)
 - Add `minEntries` and `maxEntries` validation action to validate number of object entries (pull request #1100)
 - Add `entries` and `notEntries` validation action to validate number of object entries (pull request #1156)
+- Add support for bigints to `multipleOf` validation action (pull request #1164)
 - Change implementation of `variant` and `variantAsync` schema to improve performance by aborting validation of discriminators early (pull request #1110)
 
 ## v1.0.0 (March 18, 2025)

library/src/actions/multipleOf/multipleOf.test-d.ts

@@ -30,20 +30,26 @@ describe('multipleOf', () => {
   });
 
   describe('should infer correct types', () => {
-    type Action = MultipleOfAction<number, 10, undefined>;
+    type Action1 = MultipleOfAction<number, 10, undefined>;
+    type Action2 = MultipleOfAction<bigint, 10n, undefined>;
 
     test('of input', () => {
-      expectTypeOf<InferInput<Action>>().toEqualTypeOf<number>();
+      expectTypeOf<InferInput<Action1>>().toEqualTypeOf<number>();
+      expectTypeOf<InferInput<Action2>>().toEqualTypeOf<bigint>();
     });
 
     test('of output', () => {
-      expectTypeOf<InferOutput<Action>>().toEqualTypeOf<number>();
+      expectTypeOf<InferOutput<Action1>>().toEqualTypeOf<number>();
+      expectTypeOf<InferOutput<Action2>>().toEqualTypeOf<bigint>();
     });
 
     test('of issue', () => {
-      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<
+      expectTypeOf<InferIssue<Action1>>().toEqualTypeOf<
         MultipleOfIssue<number, 10>
       >();
+      expectTypeOf<InferIssue<Action2>>().toEqualTypeOf<
+        MultipleOfIssue<bigint, 10n>
+      >();
     });
   });
 });

library/src/actions/multipleOf/multipleOf.test.ts

@@ -1,11 +1,7 @@
 import { describe, expect, test } from 'vitest';
 import type { NumberIssue } from '../../schemas/index.ts';
 import { expectActionIssue, expectNoActionIssue } from '../../vitest/index.ts';
-import {
-  multipleOf,
-  type MultipleOfAction,
-  type MultipleOfIssue,
-} from './multipleOf.ts';
+import { multipleOf, type MultipleOfAction } from './multipleOf.ts';
 
 describe('multipleOf', () => {
   describe('should return action object', () => {
@@ -45,8 +41,6 @@ describe('multipleOf', () => {
   });
 
   describe('should return dataset without issues', () => {
-    const action = multipleOf(5);
-
     test('for untyped inputs', () => {
       const issues: [NumberIssue] = [
         {
@@ -59,7 +53,7 @@ describe('multipleOf', () => {
         },
       ];
       expect(
-        action['~run']({ typed: false, value: null, issues }, {})
+        multipleOf(5)['~run']({ typed: false, value: null, issues }, {})
       ).toStrictEqual({
         typed: false,
         value: null,
@@ -68,30 +62,52 @@ describe('multipleOf', () => {
     });
 
     test('for valid numbers', () => {
-      expectNoActionIssue(action, [-15, -10, -5, 0, 5, 10, 15]);
+      expectNoActionIssue(multipleOf(5), [-15, -10, -5, 0, 5, 10, 15]);
+    });
+
+    test('for valid bigints', () => {
+      expectNoActionIssue(multipleOf(5n), [-15n, -10n, -5n, 0n, 5n, 10n, 15n]);
     });
   });
 
   describe('should return dataset with issues', () => {
-    const action = multipleOf(5, 'message');
-    const baseIssue: Omit<MultipleOfIssue<number, 5>, 'input' | 'received'> = {
+    const baseIssue = {
       kind: 'validation',
       type: 'multiple_of',
       expected: '%5',
       message: 'message',
-      requirement: 5,
-    };
+    } as const;
 
     test('for invalid numbers', () => {
-      expectActionIssue(action, baseIssue, [-14, -9, -4, 1, 3, 6, 11]);
+      expectActionIssue(
+        multipleOf(5, 'message'),
+        { ...baseIssue, requirement: 5 },
+        [-14, -9, -4, 1, 3, 6, 11]
+      );
     });
 
     test('for infinity', () => {
-      expectActionIssue(action, baseIssue, [-Infinity, Infinity]);
+      expectActionIssue(
+        multipleOf(5, 'message'),
+        { ...baseIssue, requirement: 5 },
+        [-Infinity, Infinity]
+      );
     });
 
     test('for NaN', () => {
-      expectActionIssue(action, baseIssue, [NaN]);
+      expectActionIssue(
+        multipleOf(5, 'message'),
+        { ...baseIssue, requirement: 5 },
+        [NaN]
+      );
+    });
+
+    test('for invalid bigints', () => {
+      expectActionIssue(
+        multipleOf(5n, 'message'),
+        { ...baseIssue, requirement: 5n },
+        [-14n, -9n, -4n, 1n, 3n, 6n, 11n]
+      );
     });
   });
 });

library/src/actions/multipleOf/multipleOf.ts

@@ -5,12 +5,17 @@ import type {
 } from '../../types/index.ts';
 import { _addIssue } from '../../utils/index.ts';
 
+/**
+ * Input type
+ */
+type Input = number | bigint;
+
 /**
  * Multiple of issue interface.
  */
 export interface MultipleOfIssue<
-  TInput extends number,
-  TRequirement extends number,
+  TInput extends Input,
+  TRequirement extends Input,
 > extends BaseIssue<TInput> {
   /**
    * The issue kind.
@@ -27,7 +32,7 @@ export interface MultipleOfIssue<
   /**
    * The received property.
    */
-  readonly received: `${number}`;
+  readonly received: `${TInput}`;
   /**
    * The divisor.
    */
@@ -38,8 +43,8 @@ export interface MultipleOfIssue<
  * Multiple of action interface.
  */
 export interface MultipleOfAction<
-  TInput extends number,
-  TRequirement extends number,
+  TInput extends Input,
+  TRequirement extends Input,
   TMessage extends
     | ErrorMessage<MultipleOfIssue<TInput, TRequirement>>
     | undefined,
@@ -82,6 +87,18 @@ export function multipleOf<
   const TRequirement extends number,
 >(requirement: TRequirement): MultipleOfAction<TInput, TRequirement, undefined>;
 
+/**
+ * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action.
+ *
+ * @param requirement The divisor.
+ *
+ * @returns A multiple of action.
+ */
+export function multipleOf<
+  TInput extends bigint,
+  const TRequirement extends bigint,
+>(requirement: TRequirement): MultipleOfAction<TInput, TRequirement, undefined>;
+
 /**
  * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action.
  *
@@ -101,14 +118,33 @@ export function multipleOf<
   message: TMessage
 ): MultipleOfAction<TInput, TRequirement, TMessage>;
 
+/**
+ * Creates a [multiple](https://en.wikipedia.org/wiki/Multiple_(mathematics)) of validation action.
+ *
+ * @param requirement The divisor.
+ * @param message The error message.
+ *
+ * @returns A multiple of action.
+ */
+export function multipleOf<
+  TInput extends bigint,
+  const TRequirement extends bigint,
+  const TMessage extends
+    | ErrorMessage<MultipleOfIssue<TInput, TRequirement>>
+    | undefined,
+>(
+  requirement: TRequirement,
+  message: TMessage
+): MultipleOfAction<TInput, TRequirement, TMessage>;
+
 // @__NO_SIDE_EFFECTS__
 export function multipleOf(
-  requirement: number,
-  message?: ErrorMessage<MultipleOfIssue<number, number>>
+  requirement: Input,
+  message?: ErrorMessage<MultipleOfIssue<Input, Input>>
 ): MultipleOfAction<
-  number,
-  number,
-  ErrorMessage<MultipleOfIssue<number, number>> | undefined
+  Input,
+  Input,
+  ErrorMessage<MultipleOfIssue<Input, Input>> | undefined
 > {
   return {
     kind: 'validation',
@@ -119,7 +155,8 @@ export function multipleOf(
     requirement,
     message,
     '~run'(dataset, config) {
-      if (dataset.typed && dataset.value % this.requirement !== 0) {
+      // @ts-expect-error
+      if (dataset.typed && dataset.value % this.requirement != 0) {
         _addIssue(this, 'multiple', dataset, config);
       }
       return dataset;

library/src/utils/_stringify/_stringify.ts

@@ -13,6 +13,7 @@ export function _stringify(input: unknown): string {
   if (type === 'string') {
     return `"${input}"`;
   }
+  // TODO: Should we add "n" suffix to bigints?
   if (type === 'number' || type === 'bigint' || type === 'boolean') {
     return `${input}`;
   }

website/src/routes/api/(actions)/multipleOf/index.mdx

@@ -4,6 +4,7 @@ description: Creates a multiple of validation action.
 source: /actions/multipleOf/multipleOf.ts
 contributors:
   - fabian-hiller
+  - EltonLobo07
 ---
 
 import { ApiList, Property } from '~/components';
@@ -60,7 +61,7 @@ The following APIs can be combined with `multipleOf`.
 
 ### Schemas
 
-<ApiList items={['any', 'custom', 'number', 'unknown']} />
+<ApiList items={['any', 'bigint', 'custom', 'number', 'unknown']} />
 
 ### Methods
 

website/src/routes/api/(actions)/multipleOf/properties.ts

@@ -3,11 +3,17 @@ import type { PropertyProps } from '~/components';
 export const properties: Record<string, PropertyProps> = {
   TInput: {
     modifier: 'extends',
-    type: 'number',
+    type: {
+      type: 'union',
+      options: ['number', 'bigint'],
+    },
   },
   TRequirement: {
     modifier: 'extends',
-    type: 'number',
+    type: {
+      type: 'union',
+      options: ['number', 'bigint'],
+    },
   },
   TMessage: {
     modifier: 'extends',

website/src/routes/api/(schemas)/bigint/index.mdx

@@ -121,6 +121,7 @@ The following APIs can be combined with `bigint`.
     'maxValue',
     'metadata',
     'minValue',
+    'multipleOf',
     'notValue',
     'notValues',
     'rawCheck',

website/src/routes/api/(types)/MultipleOfAction/properties.ts

@@ -3,11 +3,17 @@ import type { PropertyProps } from '~/components';
 export const properties: Record<string, PropertyProps> = {
   TInput: {
     modifier: 'extends',
-    type: 'number',
+    type: {
+      type: 'union',
+      options: ['number', 'bigint'],
+    },
   },
   TRequirement: {
     modifier: 'extends',
-    type: 'number',
+    type: {
+      type: 'union',
+      options: ['number', 'bigint'],
+    },
   },
   TMessage: {
     modifier: 'extends',

website/src/routes/api/(types)/MultipleOfIssue/index.mdx

@@ -3,6 +3,7 @@ title: MultipleOfIssue
 description: Multiple of issue interface.
 contributors:
   - fabian-hiller
+  - EltonLobo07
 ---
 
 import { Property } from '~/components';