feat: finish Numeric type

README.md

@@ -14,13 +14,13 @@ yarn add ts-extended
 
 ### Example
 ```ts
+import { locked, final } from 'ts-extended';
 import type { 
     Maybe,
     Primitive,
     Newable,
     Callable
 } from 'ts-extended';
-import { locked, final } from 'ts-extended';
 
 export type F<A extends Primitive, R extends Newable> = Callable<A[], R>;
 

src/index.ts

@@ -4,7 +4,12 @@
  */
 export type Nullable = null | undefined;
 
+/**
+ * Represents a type that can hold any numeric value: number or a bigint.
+ * @type {Numeric}
+ */
 export type Numeric = number | bigint;
+
 export type Primitive = Nullable | Numeric | string | boolean | symbol;
 export type Falsy = false | '' | 0 | Nullable;
 export type IsFalsy<T> = T extends Falsy ? true : false;

tests/nullable.test.ts

@@ -2,9 +2,8 @@ import { Nullable } from 'src';
 import { describe, assertType, expect, expectTypeOf, test, it } from 'vitest';
 
 test.fails('fail test', () => {
-  type _T = { foo: boolean };
-  // @ts-expect-error, it cannot be _T, it should error out
-  expect(assertType<_T>(null)).rejects.toBe(true);
+  // @ts-expect-error, it cannot be this type, it should error out
+  expect(assertType<Nullable>({ foo: boolean })).rejects.toBe(true);
 });
 
 test('concrete types', () => {

tests/numeric.test.ts

@@ -0,0 +1,21 @@
+import { Numeric } from 'src';
+import { describe, assertType, expect, expectTypeOf, test, it } from 'vitest';
+
+test.fails('fail test', () => {
+  // @ts-expect-error, it cannot be null, it should error out
+  expect(assertType<Numeric>(null)).rejects.toBe(true);
+});
+
+test('concrete types', () => {
+  expectTypeOf(21).toMatchTypeOf<Numeric>();
+  expectTypeOf(9007199254099).toMatchTypeOf<Numeric>();
+  expectTypeOf(BigInt(69)).toMatchTypeOf<Numeric>();
+  expectTypeOf(Number(69)).toMatchTypeOf<Numeric>();
+});
+
+describe('_', () => {
+  it('should be defined', () => {
+    const _: Numeric = 1;
+    expect(_).toBeDefined();
+  });
+});