Class PredicateType

Represents a type predicate.

function isString(x: unknown): x is string {}
function assert(condition: boolean): asserts condition {}

Hierarchy (view full)

Constructors

constructor

Properties

asserts name type targetType?

Methods

fromObject getTypeString needsParenthesis stringify toObject toString visit

Constructors

constructor

  • new PredicateType(name, asserts, targetType?): Models.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

    • Optional targetType: Models.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 Models.PredicateType

Properties

asserts

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

name

name: string

The identifier name which is tested by the predicate.

Readonly type

type: "predicate" = "predicate"

The type name identifier.

Optional targetType

targetType?: Models.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.

Methods

fromObject

Protected getTypeString

needsParenthesis

stringify

toObject

toString

visit

Settings

Member Visibility

Theme

On This Page

constructorassertsnametypetargetTypefromObjectgetTypeStringneedsParenthesisstringifytoObjecttoStringvisit