Options
All
  • Public
  • Public/Protected
  • All
Menu

type-assertions

型アサーションユーティリティ
https://github.com/maboroshi-inc/type-assertions

インストール

npm install @maboroshi/type-assertions

or

yarn add @maboroshi/type-assertions

使い方

Asserts API

TypeScript 3.7 より提供された Assertion Function を用いた型アサート機能を提供する。

import { Asserts } from '@maboroshi/type-assertions'

const fn = (value: number | null) => {
  Asserts.isNumber(value)
  return value.toString()
}

fn(123) // => `123`
fn(null) // => throw error!

Guards API

Type Guard 機能を提供する。

import { Guards } from '@maboroshi/type-assertions'

const fn = (value: number | null) => {
  if (Guards.isNumber(value)) {
    return value.toString()
  }
}

fn(123) // => `123`
fn(null) // => undefined

API

API ドキュメント を見る

Index

API Object literals

API Object literals

Const Asserts

Asserts: object

isArray

  • isArray(value: unknown): assertsvalue is unknown[]
  • Parameters

    • value: unknown

    Returns assertsvalue is unknown[]

isBigInt

  • isBigInt(value: unknown): assertsvalue is bigint
  • Parameters

    • value: unknown

    Returns assertsvalue is bigint

isBoolean

  • isBoolean(value: unknown): assertsvalue is boolean
  • Parameters

    • value: unknown

    Returns assertsvalue is boolean

isDate

  • isDate(value: unknown): assertsvalue is Date
  • Parameters

    • value: unknown

    Returns assertsvalue is Date

isError

  • isError(value: unknown): assertsvalue is Error
  • Parameters

    • value: unknown

    Returns assertsvalue is Error

isFiniteNumber

  • isFiniteNumber(value: unknown): assertsvalue is number
  • Parameters

    • value: unknown

    Returns assertsvalue is number

isFunction

  • isFunction(value: unknown): assertsvalue is Function
  • Parameters

    • value: unknown

    Returns assertsvalue is Function

isGeneratorFunction

  • isGeneratorFunction(value: unknown): assertsvalue is GeneratorFunction
  • Parameters

    • value: unknown

    Returns assertsvalue is GeneratorFunction

isInteger

  • isInteger(value: unknown): assertsvalue is number
  • Parameters

    • value: unknown

    Returns assertsvalue is number

isMap

  • isMap(value: unknown): assertsvalue is Map<unknown, unknown>
  • Parameters

    • value: unknown

    Returns assertsvalue is Map<unknown, unknown>

isNaN

  • isNaN(value: unknown): assertsvalue is number

isNull

  • isNull(value: unknown): assertsvalue is null

isNumber

  • isNumber(value: unknown): assertsvalue is number

isObject

  • isObject(value: unknown): assertsvalue is object

isPlainObject

  • isPlainObject(value: unknown): assertsvalue is object

isPromise

  • isPromise(value: unknown): assertsvalue is Promise<unknown>
  • Parameters

    • value: unknown

    Returns assertsvalue is Promise<unknown>

isPromiseLike

  • isPromiseLike(value: unknown): assertsvalue is PromiseLike<unknown>
  • Parameters

    • value: unknown

    Returns assertsvalue is PromiseLike<unknown>

isRegExp

  • isRegExp(value: unknown): assertsvalue is RegExp

isSafeInteger

  • isSafeInteger(value: unknown): assertsvalue is number

isSet

  • isSet(value: unknown): assertsvalue is Set<unknown>
  • Parameters

    • value: unknown

    Returns assertsvalue is Set<unknown>

isStrictNumber

  • isStrictNumber(value: unknown): assertsvalue is number

isString

  • isString(value: unknown): assertsvalue is string

isSymbol

  • isSymbol(value: unknown): assertsvalue is symbol

isUndefined

  • isUndefined(value: unknown): assertsvalue is undefined
  • Parameters

    • value: unknown

    Returns assertsvalue is undefined

isValidDate

  • isValidDate(value: unknown): assertsvalue is Date

isWeakMap

  • isWeakMap(value: unknown): assertsvalue is WeakMap<object, unknown>
  • Parameters

    • value: unknown

    Returns assertsvalue is WeakMap<object, unknown>

isWeakSet

  • isWeakSet(value: unknown): assertsvalue is WeakSet<object>
  • Parameters

    • value: unknown

    Returns assertsvalue is WeakSet<object>

Const Guards

Guards: object

isArray

  • isArray(value: unknown): value is unknown[]
  • Parameters

    • value: unknown

    Returns value is unknown[]

isBigInt

  • isBigInt(value: unknown): value is bigint

isBoolean

  • isBoolean(value: unknown): value is boolean
  • Parameters

    • value: unknown

    Returns value is boolean

isDate

  • isDate(value: unknown): value is Date

isError

  • isError(value: unknown): value is Error

isFiniteNumber

  • isFiniteNumber(value: unknown): value is number

isFunction

  • isFunction(value: unknown): value is Function
  • Parameters

    • value: unknown

    Returns value is Function

isGeneratorFunction

  • isGeneratorFunction(value: unknown): value is GeneratorFunction
  • Parameters

    • value: unknown

    Returns value is GeneratorFunction

isInteger

  • isInteger(value: unknown): value is number

isMap

  • isMap(value: unknown): value is Map<unknown, unknown>
  • Parameters

    • value: unknown

    Returns value is Map<unknown, unknown>

isNaN

  • isNaN(value: unknown): value is number

isNull

  • isNull(value: unknown): value is null

isNumber

  • isNumber(value: unknown): value is number

isObject

  • isObject(value: unknown): value is object

isPlainObject

  • isPlainObject(value: unknown): value is object

isPromise

  • isPromise(value: unknown): value is Promise<unknown>
  • Parameters

    • value: unknown

    Returns value is Promise<unknown>

isPromiseLike

  • isPromiseLike(value: unknown): value is PromiseLike<unknown>
  • Parameters

    • value: unknown

    Returns value is PromiseLike<unknown>

isRegExp

  • isRegExp(value: unknown): value is RegExp

isSafeInteger

  • isSafeInteger(value: unknown): value is number

isSet

  • isSet(value: unknown): value is Set<unknown>
  • Parameters

    • value: unknown

    Returns value is Set<unknown>

isStrictNumber

  • isStrictNumber(value: unknown): value is number

isString

  • isString(value: unknown): value is string

isSymbol

  • isSymbol(value: unknown): value is symbol

isUndefined

  • isUndefined(value: unknown): value is undefined

isValidDate

  • isValidDate(value: unknown): value is Date

isWeakMap

  • isWeakMap(value: unknown): value is WeakMap<object, unknown>
  • Parameters

    • value: unknown

    Returns value is WeakMap<object, unknown>

isWeakSet

  • isWeakSet(value: unknown): value is WeakSet<object>
  • Parameters

    • value: unknown

    Returns value is WeakSet<object>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc