type-plus 3.13.0 → 4.0.0

package/src/assertion/assertType.spec.ts

@@ -1,507 +0,0 @@
-import a from 'assertron'
-import { AnyConstructor, AnyFunction, assertType, Equal } from '..'
-
-describe('assertType()', () => {
-  test('input satisfies specified type', () => {
-    const subject = { a: 1, b: 2 } as const
-    assertType<{ a: 1 }>(subject)
-  })
-  test('Specify T in the validate function', () => {
-    const s: unknown = false
-    assertType(s, (s: boolean) => typeof s === 'boolean')
-    assertType<boolean>(s)
-  })
-  test('Specify T at type declaration', () => {
-    const s: unknown = false
-    assertType<boolean>(s, s => typeof s === 'boolean')
-    assertType<boolean>(s)
-  })
-  test('error message contains info from validator', () => {
-    const s: unknown = 1
-    a.throws(() => assertType(s, s => typeof s === 'boolean'), e => /subject fails to satisfy s => typeof s === 'boolean'/.test(e))
-  })
-  test('Class as validator', () => {
-    const s: unknown = new Error()
-    assertType(s, Error)
-    assertType<Error>(s)
-  })
-  test('Class as validator fails', () => {
-    class Foo { }
-    const s: unknown = 1
-    a.throws(
-      () => assertType(s, Foo),
-      (e: Error) => /subject fails to satisfy class Foo{}/.test(e.message)
-    )
-  })
-  test('subject can be type any', () => {
-    const s: any = false
-    assertType<boolean>(s, s => typeof s === 'boolean')
-    assertType<boolean>(s)
-  })
-})
-
-describe('assertType.isUndefined()', () => {
-  test('ensure the input type is undefined and nothing else', () => {
-    assertType.isUndefined(undefined)
-
-    // These fails
-    // assertType.isUndefined(null)
-    // assertType.isUndefined(1)
-    // assertType.isUndefined(true)
-    // assertType.isUndefined('a')
-    // assertType.isUndefined([])
-    // assertType.isUndefined({})
-    // assertType.isUndefined(undefined as undefined | number)
-    // assertType.isUndefined(undefined as unknown)
-  })
-  test('not undefined throws TypeError', () => {
-    a.throws(() => assertType.isUndefined(1 as any), TypeError)
-  })
-  test('narrow any to undefined', () => {
-    const x: any = undefined
-    assertType.isUndefined(x)
-    assertType.isTrue(true as Equal<undefined, typeof x>)
-  })
-})
-
-describe('assertType.noUndefined()', () => {
-  test('ensure the input type does not contain undefined', () => {
-    assertType.noUndefined(null)
-    assertType.noUndefined(1)
-    assertType.noUndefined(true)
-    assertType.noUndefined('a')
-    assertType.noUndefined([])
-    assertType.noUndefined({})
-
-    // These fails
-    // assertType.noUndefined(undefined)
-    // assertType.noUndefined(1 as undefined | number)
-    assertType.noUndefined(1 as unknown)
-  })
-  test('undefined throws TypeError', () => {
-    a.throws(() => assertType.noUndefined(undefined as any), TypeError)
-  })
-})
-
-describe('assertType.isNull()', () => {
-  test('ensure the input type is null and nothing else', () => {
-    assertType.isNull(null)
-
-    a.throws(() => assertType.isNull(1 as any), TypeError)
-    const x: any = null
-    assertType.isNull(x)
-    // `x` is narrowed to `null` here
-    assertType.isNull(x)
-
-    // These fails
-    // assertType.isNull(undefined)
-    // assertType.isNull(1)
-    // assertType.isNull(true)
-    // assertType.isNull('a')
-    // assertType.isNull([])
-    // assertType.isNull({})
-    // assertType.isNull(null as null | undefined)
-    // assertType.isNull(null as unknown)
-  })
-  test('not null throws TypeError', () => {
-    a.throws(() => assertType.isNull(1 as any), TypeError)
-  })
-  test('narrow any to null', () => {
-    const x: any = null
-    assertType.isNull(x)
-    assertType.isTrue(true as Equal<null, typeof x>)
-  })
-})
-
-describe('assertType.noNull()', () => {
-  test('ensure the input type does not contain null', () => {
-    assertType.noNull(undefined)
-    assertType.noNull(1)
-    assertType.noNull(true)
-    assertType.noNull('a')
-    assertType.noNull([])
-    assertType.noNull({})
-
-    // These fails
-    // assertType.noNull(null)
-    // assertType.noNull(undefined as undefined | null)
-  })
-  test('null throws TypeError', () => {
-    a.throws(() => assertType.noNull(null as any), TypeError)
-  })
-})
-
-describe('assertType.isNumber()', () => {
-  test('ensure the input type is number and nothing else', () => {
-    assertType.isNumber(0)
-
-    // These fails
-    // assertType.isNumber(undefined)
-    // assertType.isNumber(null)
-    // assertType.isNumber(true)
-    // assertType.isNumber('a')
-    // assertType.isNumber([])
-    // assertType.isNumber({})
-    // assertType.isNumber(1 as number | undefined)
-    // assertType.isNumber(1 as unknown)
-  })
-  test('not number throws TypeError', () => {
-    a.throws(() => assertType.isNumber(undefined as any), TypeError)
-  })
-  test('narrow any to number', () => {
-    const x: any = 1
-    assertType.isNumber(x)
-    assertType.isTrue(true as Equal<number, typeof x>)
-  })
-})
-
-describe('assertType.noNumber()', () => {
-  test('ensure the input type does not contain number', () => {
-    assertType.noNumber(undefined)
-    assertType.noNumber(null)
-    assertType.noNumber(true)
-    assertType.noNumber('a')
-    assertType.noNumber([])
-    assertType.noNumber({})
-
-    // These fails
-    // assertType.noNumber(1)
-    // assertType.noNumber(1 as number | undefined)
-  })
-  test('number throws TypeError', () => {
-    a.throws(() => assertType.noNumber(1 as any), TypeError)
-  })
-})
-
-describe('assertType.isBoolean()', () => {
-  test('ensure the input type is boolean and nothing else', () => {
-    assertType.isBoolean(true)
-    assertType.isBoolean(false)
-
-    // These fails
-    // assertType.isBoolean(undefined)
-    // assertType.isBoolean(null)
-    // assertType.isBoolean(1)
-    // assertType.isBoolean('a')
-    // assertType.isBoolean([])
-    // assertType.isBoolean({})
-    // assertType.isBoolean(true as boolean | undefined)
-  })
-  test('not boolean throws TypeError', () => {
-    a.throws(() => assertType.isBoolean(undefined as any), TypeError)
-  })
-  test('narrow any to boolean', () => {
-    const x: any = true
-    assertType.isBoolean(x)
-    assertType.isTrue(true as Equal<boolean, typeof x>)
-  })
-})
-
-describe('assertType.noBoolean()', () => {
-  test('ensure the input type does not contain boolean', () => {
-    assertType.noBoolean(undefined)
-    assertType.noBoolean(null)
-    assertType.noBoolean(1)
-    assertType.noBoolean('a')
-    assertType.noBoolean([])
-    assertType.noBoolean({})
-
-    // These fails
-    // assertType.noBoolean(true)
-    // assertType.noBoolean(true as boolean | undefined)
-  })
-  test('boolean throws TypeError', () => {
-    a.throws(() => assertType.noBoolean(true as any), TypeError)
-  })
-})
-
-describe('assertType.isTrue()', () => {
-  test('ensure the input type is true and nothing else', () => {
-    assertType.isTrue(true)
-
-    // These fails
-    // assertType.isTrue(undefined)
-    // assertType.isTrue(null)
-    // assertType.isTrue(1)
-    // assertType.isTrue('a')
-    // assertType.isTrue(false)
-    // assertType.isTrue([])
-    // assertType.isTrue({})
-    // assertType.isTrue(true as true | undefined)
-    // assertType.isTrue(true as unknown)
-  })
-  test('not true throws TypeError', () => {
-    a.throws(() => assertType.isTrue(undefined as any), TypeError)
-  })
-  test('narrow any to true', () => {
-    const x: any = true
-    assertType.isTrue(x)
-    assertType.isTrue(true as Equal<true, typeof x>)
-  })
-})
-
-describe('assertType.noTrue()', () => {
-  test('ensure the input type does not contain boolean', () => {
-    assertType.noTrue(false)
-    assertType.noTrue(undefined)
-    assertType.noTrue(null)
-    assertType.noTrue(1)
-    assertType.noTrue('a')
-    assertType.noTrue([])
-    assertType.noTrue({})
-
-    // These fails
-    // assertType.noTrue(true)
-    // assertType.noTrue(true as true | undefined)
-    // assertType.noTrue(true as boolean | undefined)
-  })
-  test('true throws TypeError', () => {
-    a.throws(() => assertType.noTrue(true as any), TypeError)
-  })
-})
-
-describe('assertType.isFalse()', () => {
-  test('ensure the input type is false and nothing else', () => {
-    assertType.isFalse(false)
-
-    a.throws(() => assertType.isFalse(true as any), TypeError)
-    const x: any = false
-    assertType.isFalse(x)
-    // `x` is narrowed to `true` here
-    assertType.isFalse(x)
-
-    // These fails
-    // assertType.isFalse(undefined)
-    // assertType.isFalse(null)
-    // assertType.isFalse(1)
-    // assertType.isFalse('a')
-    // assertType.isFalse(false)
-    // assertType.isFalse([])
-    // assertType.isFalse({})
-    // assertType.isFalse(false as false | undefined)
-    // assertType.isFalse(false as unknown)
-  })
-  test('boolean throws TypeError', () => {
-    a.throws(() => assertType.noBoolean(true as any), TypeError)
-  })
-})
-
-describe('assertType.noFalse()', () => {
-  test('ensure the input type does not contain boolean', () => {
-    assertType.noFalse(true)
-    assertType.noFalse(undefined)
-    assertType.noFalse(null)
-    assertType.noFalse(1)
-    assertType.noFalse('a')
-    assertType.noFalse([])
-    assertType.noFalse({})
-
-    // These fails
-    // assertType.noFalse(false)
-    // assertType.noFalse(false as false | undefined)
-    // assertType.noFalse(false as boolean | undefined)
-  })
-  test('false throws TypeError', () => {
-    a.throws(() => assertType.noFalse(false as any), TypeError)
-  })
-})
-
-describe('assertType.isString()', () => {
-  test('ensure the input type is string and nothing else', () => {
-    assertType.isString('a')
-
-    // These fails
-    // assertType.isString(undefined)
-    // assertType.isString(null)
-    // assertType.isString(1)
-    // assertType.isString(true)
-    // assertType.isString([])
-    // assertType.isString({})
-    // assertType.isString('a' as string | undefined)
-    // assertType.isString('a' as unknown)
-  })
-  test('not string throws TypeError', () => {
-    a.throws(() => assertType.isString(undefined as any), TypeError)
-  })
-  test('narrow any to string', () => {
-    const x: any = ''
-    assertType.isString(x)
-    assertType.isTrue(true as Equal<string, typeof x>)
-  })
-})
-
-describe('assertType.noString()', () => {
-  test('ensure the input type does not contain boolean', () => {
-    assertType.noString(undefined)
-    assertType.noString(null)
-    assertType.noString(1)
-    assertType.noString(true)
-    assertType.noString([])
-    assertType.noString({})
-
-    // These fails
-    // assertType.noString('a')
-    // assertType.noString('a' as string | undefined)
-  })
-  test('string throws TypeError', () => {
-    a.throws(() => assertType.noString('' as any), TypeError)
-  })
-})
-
-describe('assertType.isFunction()', () => {
-  test('ensure the input type is function and nothing else', () => {
-    assertType.isFunction(() => { })
-    assertType.isFunction(function () { })
-
-    // These fails
-    // assertType.isFunction(undefined)
-    // assertType.isFunction(null)
-    // assertType.isFunction(1)
-    // assertType.isFunction('a')
-    // assertType.isFunction([])
-    // assertType.isFunction({})
-    // assertType.isFunction((() => { }) as AnyFunction | undefined)
-  })
-  test('not function throws TypeError', () => {
-    a.throws(() => assertType.isFunction(undefined as any), TypeError)
-  })
-  test('narrow any to function', () => {
-    const x: any = () => { }
-    assertType.isFunction(x)
-    assertType.isTrue(true as Equal<AnyFunction, typeof x>)
-  })
-})
-
-describe('assertType.noFunction()', () => {
-  test('ensure the input type does not contain function', () => {
-    assertType.noFunction(undefined)
-    assertType.noFunction(null)
-    assertType.noFunction(1)
-    assertType.noFunction('a')
-    assertType.noFunction([])
-    assertType.noFunction({})
-
-    // These fails
-    // assertType.noFunction(() => {})
-    // assertType.noFunction((() => {}) as AnyFunction | undefined)
-  })
-  test('function throws TypeError', () => {
-    a.throws(() => assertType.noFunction((() => { }) as any), TypeError)
-  })
-})
-
-describe('assertType.isConstructor()', () => {
-  test('ensure the input type is constructor and nothing else', () => {
-    class Foo { }
-    assertType.isConstructor(Foo)
-
-    // These fails
-    // assertType.isConstructor(function () { })
-    // assertType.isConstructor(undefined)
-    // assertType.isConstructor(null)
-    // assertType.isConstructor(1)
-    // assertType.isConstructor('a')
-    // assertType.isConstructor([])
-    // assertType.isConstructor({})
-    // assertType.isConstructor((() => { }) as AnyFunction | undefined)
-  })
-  test('not constructor throws TypeError', () => {
-    a.throws(() => assertType.isConstructor(undefined as any), TypeError)
-  })
-  test('narrow any to constructor', () => {
-    class Foo { }
-    const x: any = Foo
-    assertType.isConstructor(x)
-    assertType.isTrue(true as Equal<AnyConstructor, typeof x>)
-  })
-})
-
-describe('assertType.isError()', () => {
-  test('ensure the input type is instance of Error and nothing else', () => {
-    assertType.isError(new Error('x'))
-
-    a.throws(() => assertType.isError(false as any), TypeError)
-    const x: any = new Error()
-    assertType.isError(x)
-    // `x` is narrowed to `true` here
-    assertType.isError(x)
-
-    // These fails
-    // assertType.isError(undefined)
-    // assertType.isError(null)
-    // assertType.isError(1)
-    // assertType.isError(true)
-    // assertType.isError([])
-    // assertType.isError({})
-    // assertType.isError('a')
-    // assertType.isError(new Error() as Error | undefined)
-    // assertType.isError(new Error() as unknown)
-  })
-
-  test('not error throws TypeError', () => {
-    a.throws(() => assertType.isError(undefined as any), TypeError)
-  })
-  test('narrow any to Error', () => {
-    const x: any = new Error('hello')
-    assertType.isError(x)
-    assertType.isTrue(true as Equal<Error, typeof x>)
-  })
-})
-
-describe('assertType.noError()', () => {
-  test('ensure the input type does not contain Error', () => {
-    assertType.noError(undefined)
-    assertType.noError(null)
-    assertType.noError(1)
-    assertType.noError('a')
-    assertType.noError([])
-    assertType.noError({})
-
-    // These fails
-    // assertType.noError(new Error('a'))
-    // assertType.noError(new Error('a') as Error | undefined)
-  })
-  test('error instance throws TypeError', () => {
-    a.throws(() => assertType.noError(new Error('a') as any), TypeError)
-  })
-})
-
-describe('assertType.isNever()', () => {
-  test('ensure the input type is never and nothing else', () => {
-    const s: never = 0 as never
-    assertType.isNever(s)
-
-    // these fails
-    // assertType.isNever(undefined)
-    // assertType.isNever(null)
-    // assertType.isNever(1)
-    // assertType.isNever('a')
-    // assertType.isNever(false)
-    // assertType.isNever([])
-    // assertType.isNever({})
-    // assertType.isNever(x as any)
-    // assertType.isNever(false as never | undefined)
-    // assertType.isNever(false as unknown)
-  })
-  test('boolean throws TypeError', () => {
-    a.throws(() => assertType.noBoolean(true as any), TypeError)
-  })
-})
-
-describe('assertType.custom', () => {
-  test('specify T in the validator', () => {
-    const isBool = assertType.custom((s: boolean) => typeof s === 'boolean')
-    const s: unknown = false
-    expect(isBool(s)).toBe(undefined)
-  })
-  test('specify T at type declaration', () => {
-    const isBool = assertType.custom<boolean>(s => typeof s === 'boolean')
-    const s: unknown = false
-    expect(isBool(s)).toBe(undefined)
-  })
-  test('error message contains info from validator', () => {
-    const isBool = assertType.custom<boolean>(s => typeof s === 'boolean')
-    const s: unknown = 1
-    a.throws(() => isBool(s), e => /subject fails to satisfy s => typeof s === 'boolean'/.test(e))
-  })
-})

package/src/assertion/assertType.ts

@@ -1,105 +0,0 @@
-import { tersify } from 'tersify'
-import { AnyConstructor, isConstructor } from '../class'
-import { AnyFunction } from '../function'
-
-/**
- * assert the subject satisfies the specified type T
- * @type T the type to check against.
- */
-export function assertType<T>(subject: T): asserts subject is T
-export function assertType<T>(subject: unknown, validator: (s: T) => boolean): asserts subject is T
-export function assertType<T extends new (...args: any) => any>(subject: unknown, constructor: T): asserts subject is InstanceType<T>
-export function assertType(subject: unknown, validator?: (s: any) => boolean) {
-  if (validator) {
-    if ((isConstructor(validator) && !(subject instanceof validator)) || !validator(subject))
-      throw new TypeError(`subject fails to satisfy ${tersify(validator)}`)
-  }
-  return
-}
-
-assertType.isUndefined = function (subject: undefined): asserts subject is undefined {
-  if (typeof subject !== 'undefined') throw TypeError(`subject is not undefined`)
-}
-assertType.noUndefined = function <S>(subject: Exclude<S, undefined>): void {
-  if (typeof subject === 'undefined') throw TypeError(`subject is undefined`)
-}
-
-assertType.isNull = function (subject: null): asserts subject is null {
-  if (subject !== null) throw TypeError(`subject is not null`)
-}
-assertType.noNull = function <S>(subject: Exclude<S, null>): void {
-  if (subject === null) throw TypeError(`subject is null`)
-}
-
-assertType.isNumber = function (subject: number): asserts subject is number {
-  if (typeof subject !== 'number') throw TypeError(`subject is not number`)
-}
-assertType.noNumber = function <S>(subject: Exclude<S, number>): void {
-  if (typeof subject === 'number') throw TypeError(`subject is number`)
-}
-
-assertType.isBoolean = function (subject: boolean): asserts subject is boolean {
-  if (typeof subject !== 'boolean') throw TypeError(`subject is not boolean`)
-}
-assertType.noBoolean = function <S>(subject: Exclude<S, boolean>): void {
-  if (typeof subject === 'boolean') throw TypeError(`subject is boolean`)
-}
-
-assertType.isTrue = function (subject: true): asserts subject is true {
-  if (subject !== true) throw TypeError(`subject is not true`)
-}
-assertType.noTrue = function <S>(subject: Exclude<S, true>): void {
-  // @ts-ignore
-  if (subject === true) throw TypeError(`subject is true`)
-}
-
-assertType.isFalse = function (subject: false): asserts subject is false {
-  if (subject !== false) throw TypeError(`subject is not false`)
-}
-assertType.noFalse = function <S>(subject: Exclude<S, false>): void {
-  // @ts-ignore
-  if (subject === false) throw TypeError(`subject is false`)
-}
-
-assertType.isString = function (subject: string): asserts subject is string {
-  if (typeof subject !== 'string') throw TypeError(`subject is not string`)
-}
-assertType.noString = function <S>(subject: Exclude<S, string>): void {
-  if (typeof subject === 'string') throw TypeError(`subject is string`)
-}
-
-assertType.isFunction = function (subject: AnyFunction): asserts subject is AnyFunction {
-  if (typeof subject !== 'function') throw TypeError(`subject is not function`)
-}
-assertType.noFunction = function <S>(subject: Exclude<S, AnyFunction>): void {
-  if (typeof subject === 'function') throw TypeError(`subject is function`)
-}
-
-assertType.isConstructor = function (subject: AnyConstructor): asserts subject is AnyConstructor {
-  if (!isConstructor(subject)) throw TypeError(`subject is not a constructor`)
-}
-
-assertType.isError = function (subject: Error): asserts subject is Error {
-  if (!(subject instanceof Error)) throw TypeError(`subject is not an Error`)
-}
-assertType.noError = function <S>(subject: Exclude<S, Error>): void {
-  if (subject instanceof Error) throw TypeError(`subject is an Error`)
-}
-
-assertType.isNever = function (subject: never): asserts subject is never {
-}
-
-/**
- * creates a custom assertion function with standard TypeError.
- * Currently this requires explicity type annotation,
- * thus making it hard to use:
- * https://github.com/microsoft/TypeScript/issues/41047
- */
-assertType.custom = function <T>(
-  validator: (s: T) => boolean
-): (subject: unknown) => asserts subject is T {
-  return function (subject) {
-    if (!validator(subject as any)) throw new TypeError(`subject fails to satisfy ${tersify(validator)}`)
-    return
-  }
-}

package/src/assertion/index.ts

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

package/src/class/AnyConstructor.spec.ts

@@ -1,13 +0,0 @@
-import { AnyConstructor } from '..'
-
-test('basic', () => {
-  const a = function () { } as any as AnyConstructor
-
-  new a()
-})
-
-test('specify params with tuple', () => {
-  const a = function () { } as any as AnyConstructor<[count: number, value: string]>
-
-  new a(1, 'a')
-})

package/src/class/isConstructor.spec.ts

@@ -1,35 +0,0 @@
-import { AnyConstructor, assertType, isConstructor } from '..'
-
-test('check constructor', () => {
-  const x: unknown = Error
-  if (isConstructor(x))
-    assertType<AnyConstructor>(x)
-})
-
-test('check not constructor', () => {
-  expect(isConstructor(() => { })).toBe(false)
-})
-
-test('check throw function', () => {
-  expect(isConstructor(() => { throw new Error() })).toBe(false)
-})
-
-test('check throwing constructor is still true', () => {
-  class Foo { constructor() { throw new Error() } }
-  expect(isConstructor(Foo)).toBe(true)
-})
-
-test('constructor throwing non-error', () => {
-  class Foo { constructor() { throw 'abc' } }
-  expect(isConstructor(Foo)).toBe(true)
-})
-
-test('constructor throwing undefined', () => {
-  class Foo { constructor() { throw undefined } }
-  expect(isConstructor(Foo)).toBe(true)
-})
-
-test('class with params returns true', () => {
-  class Boo { constructor(public a: number) { } }
-  expect(isConstructor(Boo)).toBe(true)
-})

package/src/class/isConstructor.ts

@@ -1,15 +0,0 @@
-import { AnyConstructor } from './AnyConstructor'
-
-export function isConstructor(subject: unknown): subject is AnyConstructor {
-  try {
-    new (subject as AnyConstructor)()
-  }
-  catch (err) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const msg = err?.message as string | undefined
-    if (msg && msg.indexOf('is not a constructor') >= 0) {
-      return false
-    }
-  }
-  return true
-}

package/src/function/AnyFunction.spec.ts

@@ -1,21 +0,0 @@
-import { AnyFunction, assertType } from '..'
-
-test('basic', () => {
-  function doCallback(cb: AnyFunction) {
-    cb()
-  }
-
-  doCallback(() => { })
-  doCallback(_ => { })
-  doCallback((a: number, b: number) => a + b)
-})
-
-test('define param as tuple', () => {
-  const foo: AnyFunction<[number, string]> = x => x
-  foo(1, 'a')
-})
-
-test('define result type', () => {
-  const foo: AnyFunction<string[], string> = x => x
-  assertType.isString(foo('a'))
-})