type-plus 4.3.0 → 4.4.0

package/ts/math/Subtract.ts

@@ -1,40 +1,43 @@
-import { PadLeft, Some, Tail } from '../array'
-import { And } from '../predicates'
-import { Digit, DigitArray } from './Digit'
-import { IsPositive } from './IsPositive'
-import { IsWhole } from './IsWhole'
-import { Max } from './Max'
-
-export type Subtract<A extends number, B extends number, Fail = never> =
-  And<
-    And<IsPositive<A>, IsWhole<A>>,
-    And<IsPositive<B>, IsWhole<B>>
-  > extends true
-  ? (DigitArray.Shift10<DigitArray.FromNumber<A>> extends infer DA ? DA extends number[] ?
-    DigitArray.FromNumber<B> extends infer DB ? DB extends number[] ?
-    Max<DA['length'], DB['length']> extends infer M ? M extends number ?
-    PadLeft<DA, M, 0> extends infer PDA ? PDA extends number[] ?
-    PadLeft<DB, M, 0> extends infer PDB ? PDB extends number[] ?
-    SubtractDigitArray<[], PDA, PDB> extends infer Result ? Result extends number[] ?
-    Some<Result, never, 'strict'> extends true ? Fail :
-    DigitArray.ToNumber<Result>
-    : Fail : Fail
-    : Fail : Fail
-    : Fail : Fail
-    : Fail : Fail
-    : Fail : Fail
-    : Fail : Fail)
-  : Fail
-
-type SubtractDigitArray<R extends number[], A extends number[], B extends number[]> =
-  A['length'] extends 0 ? R :
-  SubtractDigitArray<[...R, SubtractDigit<A[0], B[0]>], Tail<A>, Tail<B>>
-
-
-type SubtractDigit<A extends number, B extends number> =
-  Digit.ToTuple[A] extends [...(infer U), ...Digit.ToTuple[B]] ? U['length'] : never
-
-/**
- * A - 1
- */
-export type Decrement<A extends number, Fail = never> = Subtract<A, 1, Fail>
+import type { PadLeft, Some, Tail } from '../array'
+import type { And } from '../predicates'
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { Digit, DigitArray } from './Digit'
+import type { IsPositive } from './IsPositive'
+import type { IsWhole } from './IsWhole'
+import type { Max } from './Max'
+
+export type Subtract<A extends number, B extends number, Fail = never> =
+  And<
+    And<IsPositive<A>, IsWhole<A>>,
+    And<IsPositive<B>, IsWhole<B>>
+  > extends true
+  ? (DigitArray.Shift10<DigitArray.FromNumber<A>> extends infer DA ? DA extends number[] ?
+    DigitArray.FromNumber<B> extends infer DB ? DB extends number[] ?
+    Max<DA['length'], DB['length']> extends infer M ? M extends number ?
+    PadLeft<DA, M, 0> extends infer PDA ? PDA extends number[] ?
+    PadLeft<DB, M, 0> extends infer PDB ? PDB extends number[] ?
+    Subtract.DigitArray<[], PDA, PDB> extends infer Result ? Result extends number[] ?
+    Some<Result, never, 'strict'> extends true ? Fail :
+    DigitArray.ToNumber<Result>
+    : Fail : Fail
+    : Fail : Fail
+    : Fail : Fail
+    : Fail : Fail
+    : Fail : Fail
+    : Fail : Fail)
+  : Fail
+
+export namespace Subtract {
+  export type DigitArray<R extends number[], A extends number[], B extends number[]> =
+    A['length'] extends 0 ? R :
+    DigitArray<[...R, Digit<A[0], B[0]>], Tail<A>, Tail<B>>
+
+
+  export type Digit<A extends number, B extends number> =
+    Digit.ToTuple[A] extends [...(infer U), ...Digit.ToTuple[B]] ? U['length'] : never
+}
+
+/**
+ * A - 1
+ */
+export type Decrement<A extends number, Fail = never> = Subtract<A, 1, Fail>

package/ts/math/index.ts

@@ -1,5 +1,6 @@
 export type { Abs } from './Abs'
 export type { Add, Increment } from './Add'
+export type { Digit, DigitArray } from './Digit'
 export type { GreaterThan } from './GreaterThan'
 export type { IsPositive } from './IsPositive'
 export type { IsWhole } from './IsWhole'

package/ts/nodejs/isNodeError.ts

@@ -1,5 +1,4 @@
-
-type SystemErrors = {
+export type SystemErrors = {
   'EACCES': Error & { code: 'EACCES' },
   'EADDRINUSE': Error & { code: 'EADDRINUSE' },
   'ECONNREFUSED': Error,

package/ts/object/split.ts

@@ -1,7 +1,7 @@
 import { AnyRecord, Omit, reduceByKey } from '..'
 
 type Splitter<T extends AnyRecord> = Partial<{ [k in keyof T]: T[k] | undefined }>
-type Split<T extends AnyRecord, S extends AnyRecord> = { [k in keyof S]: NonNullable<T[k]> | S[k] }
+export type Split<T extends AnyRecord, S extends AnyRecord> = { [k in keyof S]: NonNullable<T[k]> | S[k] }
 
 /**
  * Split an object into multiple objects.

package/ts/testing/index.ts

@@ -0,0 +1 @@
+export * from './stub'

package/ts/testing/stub.spec.ts

@@ -0,0 +1,31 @@
+import { isType, stub } from '..'
+
+test('stub is a partial of the actual object', () => {
+  const real = { a: 1, b: { c: 2 }, d: 3 }
+
+  const a = stub<typeof real>({ a: 2 })
+  expect(a.a).toBe(2)
+  isType.equal<true, typeof a, typeof real>()
+})
+
+test('stub function retains param types', () => {
+  function real(a: string, b: number): boolean { return a === String(b) }
+
+  const a = stub<typeof real>((_a, _b) => {
+    isType.equal<true, string, typeof _a>()
+    isType.equal<true, number, typeof _b>()
+    return false
+  })
+
+  expect(a('1', 1)).toBe(false)
+  isType.equal<true, typeof a, typeof real>()
+})
+
+test('stub function params can be omitted', () => {
+  function real(a: string, b: number): boolean { return a === String(b) }
+
+  const a = stub<typeof real>(() => false)
+
+  expect(a('1', 1)).toBe(false)
+  isType.equal<true, typeof a, typeof real>()
+})

package/ts/testing/stub.ts

@@ -0,0 +1,8 @@
+import { AnyFunction } from '../function'
+import { RecursivePartial } from '../object'
+
+export type Stub<T> = T extends AnyFunction ? T : RecursivePartial<T>
+
+export function stub<T>(stub: Stub<T>) {
+  return stub as T
+}

package/ts/utils/as.spec.ts

@@ -1,24 +1,33 @@
-import { as, asAny, isType } from '..'
-
-describe('as<T>()', () => {
-  test('defaults subject type to unknown', () => {
-    const s: any = {}
-    if (as(s)) isType.equal<true, unknown, typeof s>()
-  })
-
-  test('cast type to T', () => {
-    const s: any = {}
-    if (as<number>(s)) isType.equal<true, number, typeof s>()
-    if (as<string>(s)) isType.equal<true, string, typeof s>()
-    if (as<{ a: number }>(s)) isType.equal<true, { a: number }, typeof s>()
-    if (as<any>(s)) isType.equal<true, any, typeof s>()
-  })
-})
-
-describe('asAny()', () => {
-  test('cast type to any', () => {
-    const s: unknown = {}
-    if (asAny(s)) isType.equal<true, any, typeof s>()
-  })
-})
-
+import { as, asAny, isType } from '..'
+
+describe('as<T>()', () => {
+  test('defaults subject type to unknown', () => {
+    const s: any = {}
+    const a = as(s)
+    isType.equal<true, unknown, typeof a>()
+  })
+
+  test('cast type to T', () => {
+    const s: any = {}
+    const n = as<number>(s)
+    isType.equal<true, number, typeof n>()
+
+    const str = as<string>(s)
+    isType.equal<true, string, typeof str>()
+
+    const o = as<{ a: number }>(s)
+    isType.equal<true, { a: number }, typeof o>()
+
+    const any = as<any>(s)
+    isType.equal<true, any, typeof any>()
+  })
+})
+
+describe('asAny()', () => {
+  test('cast type to any', () => {
+    const s: unknown = {}
+    const a = asAny(s)
+    isType.equal<true, any, typeof a>()
+  })
+})
+

package/ts/utils/as.ts

@@ -1,7 +1,7 @@
-export function as<T>(subject: unknown): subject is T {
-  return true
-}
-
-export function asAny(subject: unknown): subject is any {
-  return true
-}
+export function as<T>(subject: unknown): T {
+  return subject as T
+}
+
+export function asAny(subject: unknown): any {
+  return subject
+}