Class PredicateType

constructor

• new PredicateType(
      name: string,
      asserts: boolean,
      targetType?: SomeType,
  ): PredicateType

  Create a new PredicateType instance.

  Parameters

  • name: string

    The identifier name which is tested by the predicate.

  • asserts: boolean

    True if the type is of the form asserts val is string, false if the type is of the form val is string

  • OptionaltargetType: SomeType

    The type that the identifier is tested to be. May be undefined if the type is of the form asserts val. Will be defined if the type is of the form asserts val is string or val is string.

  Returns PredicateType

asserts

name

OptionaltargetType

Readonlytype

estimatePrintWidth

• estimatePrintWidth(): number

  Return the estimated size of the type if it was all printed on one line.

  Returns number

fromObject

• fromObject(_de: Deserializer, _obj: SomeType): void

  Parameters

  • _de: Deserializer
  • _obj: SomeType

  Returns void

needsParenthesis

• needsParenthesis(): boolean

  Returns boolean

stringify

• stringify(context: TypeContext): string

  Parameters

  • context: TypeContext

  Returns string

toObject

• toObject(serializer: Serializer): PredicateType

  Parameters

  • serializer: Serializer

  Returns PredicateType

toString

• toString(): string

  Return a string representation of this type.

  Returns string

visit

• visit<T, A extends any[] = []>(visitor: TypeVisitor<T, A>, ...args: A): T

  Visit this type, returning the value returned by the visitor.

  Type Parameters

  • T
  • A extends any[] = []

  Parameters

  • visitor: TypeVisitor<T, A>
  • ...args: A

  Returns T

• visit<T, A extends any[] = []>(
      visitor: Partial<TypeVisitor<T, A>>,
      ...args: A,
  ): T | undefined

  Visit this type, returning the value returned by the visitor.

  Type Parameters

  • T
  • A extends any[] = []

  Parameters

  • visitor: Partial<TypeVisitor<T, A>>
  • ...args: A

  Returns T | undefined