Module

x/ts_morph/mod.ts>TypePredicateNode

TypeScript Compiler API wrapper for static analysis and programmatic code changes.
dsherret/ts-morph
Very Popular
Go to Latest
class TypePredicateNode
extends TypeNode<ts.TypePredicateNode>
import { TypePredicateNode } from "https://dotland.deno.dev/x/ts_morph@18.0.0/mod.ts";

A type predicate node which says the specified parameter name is a specific type if the function returns true.

Examples:

  • param is string in declare function isString(param: unknown): param is string;.
  • asserts condition in declare function assert(condition: any): asserts condition;.

Methods

getAssertsModifier(): Node<ts.AssertsKeyword> | undefined

Gets the asserts modifier if it exists.

getAssertsModifierOrThrow(message?: string | (() => string)): Node<ts.AssertsKeyword>

Gets the asserts modifier if it exists or throws otherwise.

getParameterNameNode(): Identifier | ThisTypeNode

Gets the parameter name node

getParent(): NodeParentType<ts.TypePredicateNode>
getParentOrThrow(message?: string | (() => string)): NonNullable<NodeParentType<ts.TypePredicateNode>>
getTypeNode(): TypeNode | undefined

Gets the type name if it exists or returns undefined when it asserts a condition.

getTypeNodeOrThrow(message?: string | (() => string)): TypeNode

Gets the type name if it exists or throws when it asserts a condition.

hasAssertsModifier(): boolean

Gets if the type predicate has an asserts modifier (ex. asserts condition).