Skip to main content

IsNumericLiteral<T>

IsNumericLiteral<T> = LiteralChecks<T, Numeric>

Defined in: packages/react-querybuilder/src/types/type-fest/is-literal.ts:170

Returns a boolean for whether the given type is a number or bigint literal type.

Useful for:

  • providing strongly-typed functions when given literal arguments
  • type utilities, such as when constructing parsers and ASTs

Type Parameters​

Type Parameter
T

Example​

import type {IsNumericLiteral} from 'type-fest';

// https://github.com/inocan-group/inferred-types/blob/master/src/types/boolean-logic/EndsWith.ts
type EndsWith<TValue, TEndsWith extends string> =
	TValue extends string
		? IsStringLiteral<TEndsWith> extends true
			? IsStringLiteral<TValue> extends true
				? TValue extends `${string}${TEndsWith}`
					? true
					: false
				: boolean
			: boolean
		: TValue extends number
			? IsNumericLiteral<TValue> extends true
				? EndsWith<`${TValue}`, TEndsWith>
				: false
			: false;

function endsWith<Input extends string | number, End extends string>(input: Input, end: End) {
	return `${input}`.endsWith(end) as EndsWith<Input, End>;
}

endsWith('abc', 'c');
//=> true

endsWith(123456, '456');
//=> true

const end = '123' as string;

endsWith('abc123', end);
//=> boolean
caution

API documentation is generated from the latest commit on the main branch. It may be somewhat inconsistent with official releases of React Query Builder.