(aliased-symbol type-checker symbol)
Follow all aliases to get the original symbol.
Parameters:
symbol
: Symbol
Returns: Symbol
Follow all aliases to get the original symbol. **Parameters:** - `symbol`: `Symbol` **Returns:** `Symbol`
(ambient-modules type-checker)
Returns: Symbol[]
**Returns:** `Symbol[]`
(any-type type-checker)
Gets the intrinsic any
type. There are multiple types that act as any
used internally in the compiler,
so the type returned by this function should not be used in equality checks to determine if another type
is any
. Instead, use type.flags & TypeFlags.Any
.
Returns: Type
Gets the intrinsic `any` type. There are multiple types that act as `any` used internally in the compiler, so the type returned by this function should not be used in equality checks to determine if another type is `any`. Instead, use `type.flags & TypeFlags.Any`. **Returns:** `Type`
(apparent-type type-checker type)
Parameters:
type
: Type
Returns: Type
**Parameters:** - `type`: `Type` **Returns:** `Type`
(arguments-symbol? type-checker symbol)
Parameters:
symbol
: Symbol
Returns: boolean
**Parameters:** - `symbol`: `Symbol` **Returns:** `boolean`
(array-like-type? type-checker type)
True if this type is assignable to ReadonlyArray<any>
.
Parameters:
type
: Type
Returns: boolean
True if this type is assignable to `ReadonlyArray<any>`. **Parameters:** - `type`: `Type` **Returns:** `boolean`
(array-type? type-checker type)
True if this type is the Array
or ReadonlyArray
type from lib.d.ts.
This function will not return true if passed a type which
extends Array
(for example, the TypeScript AST's NodeArray
type).
Parameters:
type
: Type
Returns: boolean
True if this type is the `Array` or `ReadonlyArray` type from lib.d.ts. This function will _not_ return true if passed a type which extends `Array` (for example, the TypeScript AST's `NodeArray` type). **Parameters:** - `type`: `Type` **Returns:** `boolean`
(augmented-properties-of-type type-checker type)
Parameters:
type
: Type
Returns: Symbol[]
**Parameters:** - `type`: `Type` **Returns:** `Symbol[]`
(base-constraint-of-type type-checker type)
Parameters:
type
: Type
Returns: Type | undefined
**Parameters:** - `type`: `Type` **Returns:** `Type | undefined`
(base-type-of-literal-type type-checker type)
Parameters:
type
: Type
Returns: Type
**Parameters:** - `type`: `Type` **Returns:** `Type`
(base-types type-checker type)
Parameters:
type
: InterfaceType
Returns: BaseType[]
**Parameters:** - `type`: `InterfaceType` **Returns:** `BaseType[]`
(constant-value type-checker node)
Parameters:
node
: ElementAccessExpression | PropertyAccessExpression | EnumMember
Returns: string | number | undefined
**Parameters:** - `node`: `ElementAccessExpression | PropertyAccessExpression | EnumMember` **Returns:** `string | number | undefined`
(contextual-type type-checker node)
Parameters:
node
: Expression
Returns: Type | undefined
**Parameters:** - `node`: `Expression` **Returns:** `Type | undefined`
(declared-type-of-symbol type-checker symbol)
Parameters:
symbol
: Symbol
Returns: Type
**Parameters:** - `symbol`: `Symbol` **Returns:** `Type`
(default-from-type-parameter type-checker type)
Parameters:
type
: Type
Returns: Type | undefined
**Parameters:** - `type`: `Type` **Returns:** `Type | undefined`
(es-symbol-type type-checker)
Returns: Type
**Returns:** `Type`
(export-specifier-local-target-symbol type-checker location)
Parameters:
location
: Identifier | ExportSpecifier
Returns: Symbol | undefined
**Parameters:** - `location`: `Identifier | ExportSpecifier` **Returns:** `Symbol | undefined`
(export-symbol-of-symbol type-checker symbol)
If a symbol is a local symbol with an associated exported symbol, returns the exported symbol.
Otherwise returns its input.
For example, at export type T = number;
:
- getSymbolAtLocation
at the location T
will return the exported symbol for T
.
- But the result of getSymbolsInScope
will contain the local symbol for T
, not the exported symbol.
- Calling getExportSymbolOfSymbol
on that local symbol will return the exported symbol.
Parameters:
symbol
: Symbol
Returns: Symbol
If a symbol is a local symbol with an associated exported symbol, returns the exported symbol. Otherwise returns its input. For example, at `export type T = number;`: - `getSymbolAtLocation` at the location `T` will return the exported symbol for `T`. - But the result of `getSymbolsInScope` will contain the *local* symbol for `T`, not the exported symbol. - Calling `getExportSymbolOfSymbol` on that local symbol will return the exported symbol. **Parameters:** - `symbol`: `Symbol` **Returns:** `Symbol`
(exports-of-module type-checker module-symbol)
Parameters:
module-symbol
: Symbol
Returns: Symbol[]
**Parameters:** - `module-symbol`: `Symbol` **Returns:** `Symbol[]`
(fully-qualified-name type-checker symbol)
Parameters:
symbol
: Symbol
Returns: string
**Parameters:** - `symbol`: `Symbol` **Returns:** `string`
(immediate-aliased-symbol type-checker symbol)
Follow a single alias to get the immediately aliased symbol.
Parameters:
symbol
: Symbol
Returns: Symbol | undefined
Follow a *single* alias to get the immediately aliased symbol. **Parameters:** - `symbol`: `Symbol` **Returns:** `Symbol | undefined`
(implementation-of-overload? type-checker node)
Parameters:
node
: SignatureDeclaration
Returns: boolean | undefined
**Parameters:** - `node`: `SignatureDeclaration` **Returns:** `boolean | undefined`
(index-info-of-type type-checker type kind)
Parameters:
type
: Type
kind
: IndexKind
Returns: IndexInfo | undefined
**Parameters:** - `type`: `Type` - `kind`: `IndexKind` **Returns:** `IndexInfo | undefined`
(index-info-to-index-signature-declaration type-checker index-info)
(index-info-to-index-signature-declaration type-checker
index-info
enclosing-declaration)
(index-info-to-index-signature-declaration type-checker
index-info
enclosing-declaration
flags)
Note that the resulting nodes cannot be checked.
Parameters:
index-info
: IndexInfo
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: IndexSignatureDeclaration | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `index-info`: `IndexInfo` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `IndexSignatureDeclaration | undefined`
(index-infos-of-index-symbol type-checker)
Returns: (indexSymbol: Symbol) => IndexInfo[]
**Returns:** `(indexSymbol: Symbol) => IndexInfo[]`
(index-infos-of-type type-checker type)
Parameters:
type
: Type
Returns: readonly IndexInfo[]
**Parameters:** - `type`: `Type` **Returns:** `readonly IndexInfo[]`
(index-type-of-type type-checker type kind)
Parameters:
type
: Type
kind
: IndexKind
Returns: Type | undefined
**Parameters:** - `type`: `Type` - `kind`: `IndexKind` **Returns:** `Type | undefined`
(jsx-intrinsic-tag-names-at type-checker location)
Parameters:
location
: Node
Returns: Symbol[]
**Parameters:** - `location`: `Node` **Returns:** `Symbol[]`
(merged-symbol type-checker symbol)
Parameters:
symbol
: Symbol
Returns: Symbol
**Parameters:** - `symbol`: `Symbol` **Returns:** `Symbol`
(never-type type-checker)
Gets the intrinsic never
type. There are multiple types that act as never
used internally in the compiler,
so the type returned by this function should not be used in equality checks to determine if another type
is never
. Instead, use type.flags & TypeFlags.Never
.
Returns: Type
Gets the intrinsic `never` type. There are multiple types that act as `never` used internally in the compiler, so the type returned by this function should not be used in equality checks to determine if another type is `never`. Instead, use `type.flags & TypeFlags.Never`. **Returns:** `Type`
(non-nullable-type type-checker type)
Parameters:
type
: Type
Returns: Type
**Parameters:** - `type`: `Type` **Returns:** `Type`
(null-type type-checker)
Gets the intrinsic null
type. There are multiple types that act as null
used internally in the compiler,
so the type returned by this function should not be used in equality checks to determine if another type
is null
. Instead, use type.flags & TypeFlags.Null
.
Returns: Type
Gets the intrinsic `null` type. There are multiple types that act as `null` used internally in the compiler, so the type returned by this function should not be used in equality checks to determine if another type is `null`. Instead, use `type.flags & TypeFlags.Null`. **Returns:** `Type`
(nullable-type type-checker type flags)
Parameters:
type
: Type
flags
: TypeFlags
Returns: Type
**Parameters:** - `type`: `Type` - `flags`: `TypeFlags` **Returns:** `Type`
(number-literal-type type-checker value)
Parameters:
value
: number
Returns: NumberLiteralType
**Parameters:** - `value`: `number` **Returns:** `NumberLiteralType`
(optional-parameter? type-checker node)
Parameters:
node
: ParameterDeclaration
Returns: boolean
**Parameters:** - `node`: `ParameterDeclaration` **Returns:** `boolean`
(private-identifier-property-of-type type-checker left-type name location)
Parameters:
left-type
: Type
name
: string
location
: Node
Returns: Symbol | undefined
**Parameters:** - `left-type`: `Type` - `name`: `string` - `location`: `Node` **Returns:** `Symbol | undefined`
(properties-of-type type-checker type)
Parameters:
type
: Type
Returns: Symbol[]
**Parameters:** - `type`: `Type` **Returns:** `Symbol[]`
(property-of-type type-checker type property-name)
Parameters:
type
: Type
property-name
: string
Returns: Symbol | undefined
**Parameters:** - `type`: `Type` - `property-name`: `string` **Returns:** `Symbol | undefined`
(property-symbol-of-destructuring-assignment type-checker location)
Parameters:
location
: Identifier
Returns: Symbol | undefined
**Parameters:** - `location`: `Identifier` **Returns:** `Symbol | undefined`
(resolve-name type-checker name)
(resolve-name type-checker name location)
(resolve-name type-checker name location meaning)
(resolve-name type-checker name location meaning exclude-globals?)
Parameters:
name
: string
location
: Node | undefined
meaning
: SymbolFlags
exclude-globals?
: boolean
Returns: Symbol | undefined
**Parameters:** - `name`: `string` - `location`: `Node | undefined` - `meaning`: `SymbolFlags` - `exclude-globals?`: `boolean` **Returns:** `Symbol | undefined`
(resolved-signature type-checker node)
(resolved-signature type-checker node candidates-out-array)
(resolved-signature type-checker node candidates-out-array argument-count)
returns unknownSignature in the case of an error. returns undefined if the node is not valid.
Parameters:
node
: CallLikeExpression
candidates-out-array
: Signature[] | undefined
argument-count
: number | undefined
- Apparent number of arguments, passed in case of a possibly incomplete call. This should come from an ArgumentListInfo. See signatureHelp.ts
.Returns: Signature | undefined
returns unknownSignature in the case of an error. returns undefined if the node is not valid. **Parameters:** - `node`: `CallLikeExpression` - `candidates-out-array`: `Signature[] | undefined` - `argument-count`: `number | undefined` - Apparent number of arguments, passed in case of a possibly incomplete call. This should come from an ArgumentListInfo. See `signatureHelp.ts`. **Returns:** `Signature | undefined`
(return-type-of-signature type-checker signature)
Parameters:
signature
: Signature
Returns: Type
**Parameters:** - `signature`: `Signature` **Returns:** `Type`
(root-symbols type-checker symbol)
Parameters:
symbol
: Symbol
Returns: readonly Symbol[]
**Parameters:** - `symbol`: `Symbol` **Returns:** `readonly Symbol[]`
(run-with-cancellation-token type-checker token cb)
Depending on the operation performed, it may be appropriate to throw away the checker if the cancellation token is triggered. Typically, if it is used for error checking and the operation is cancelled, then it should be discarded, otherwise it is safe to keep.
Parameters:
token
: CancellationToken
cb
: (checker: TypeChecker) => T
Returns: T
Depending on the operation performed, it may be appropriate to throw away the checker if the cancellation token is triggered. Typically, if it is used for error checking and the operation is cancelled, then it should be discarded, otherwise it is safe to keep. **Parameters:** - `token`: `CancellationToken` - `cb`: `(checker: TypeChecker) => T` **Returns:** `T`
(set-get-index-infos-of-index-symbol! type-checker value)
(shorthand-assignment-value-symbol type-checker)
(shorthand-assignment-value-symbol type-checker location)
The function returns the value (local variable) symbol of an identifier in the short-hand property assignment. This is necessary as an identifier in short-hand property assignment can contains two meaning: property name and property value.
Parameters:
location
: Node | undefined
Returns: Symbol | undefined
The function returns the value (local variable) symbol of an identifier in the short-hand property assignment. This is necessary as an identifier in short-hand property assignment can contains two meaning: property name and property value. **Parameters:** - `location`: `Node | undefined` **Returns:** `Symbol | undefined`
(signature-from-declaration type-checker declaration)
Parameters:
declaration
: SignatureDeclaration
Returns: Signature | undefined
**Parameters:** - `declaration`: `SignatureDeclaration` **Returns:** `Signature | undefined`
(signature-to-signature-declaration type-checker signature kind)
(signature-to-signature-declaration type-checker
signature
kind
enclosing-declaration)
(signature-to-signature-declaration type-checker
signature
kind
enclosing-declaration
flags)
Note that the resulting nodes cannot be checked.
Parameters:
signature
: Signature
kind
: SyntaxKind
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: (SignatureDeclaration & { typeArguments?: NodeArray<TypeNode> | undefined; }) | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `signature`: `Signature` - `kind`: `SyntaxKind` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `(SignatureDeclaration & { typeArguments?: NodeArray<TypeNode> | undefined; }) | undefined`
(signature-to-string type-checker signature)
(signature-to-string type-checker signature enclosing-declaration)
(signature-to-string type-checker signature enclosing-declaration flags)
(signature-to-string type-checker signature enclosing-declaration flags kind)
Parameters:
signature
: Signature
enclosing-declaration
: Node | undefined
flags
: TypeFormatFlags | undefined
kind
: SignatureKind | undefined
Returns: string
**Parameters:** - `signature`: `Signature` - `enclosing-declaration`: `Node | undefined` - `flags`: `TypeFormatFlags | undefined` - `kind`: `SignatureKind | undefined` **Returns:** `string`
(signatures-of-type type-checker type kind)
Parameters:
type
: Type
kind
: SignatureKind
Returns: readonly Signature[]
**Parameters:** - `type`: `Type` - `kind`: `SignatureKind` **Returns:** `readonly Signature[]`
(string-literal-type type-checker value)
Parameters:
value
: string
Returns: StringLiteralType
**Parameters:** - `value`: `string` **Returns:** `StringLiteralType`
(symbol-at-location type-checker node)
Parameters:
node
: Node
Returns: Symbol | undefined
**Parameters:** - `node`: `Node` **Returns:** `Symbol | undefined`
(symbol-of-expando type-checker node allow-declaration?)
Parameters:
node
: Node
allow-declaration?
: boolean
Returns: Symbol | undefined
**Parameters:** - `node`: `Node` - `allow-declaration?`: `boolean` **Returns:** `Symbol | undefined`
(symbol-to-entity-name type-checker symbol meaning)
(symbol-to-entity-name type-checker symbol meaning enclosing-declaration)
(symbol-to-entity-name type-checker symbol meaning enclosing-declaration flags)
Note that the resulting nodes cannot be checked.
Parameters:
symbol
: Symbol
meaning
: SymbolFlags
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: EntityName | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `symbol`: `Symbol` - `meaning`: `SymbolFlags` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `EntityName | undefined`
(symbol-to-expression type-checker symbol meaning)
(symbol-to-expression type-checker symbol meaning enclosing-declaration)
(symbol-to-expression type-checker symbol meaning enclosing-declaration flags)
Note that the resulting nodes cannot be checked.
Parameters:
symbol
: Symbol
meaning
: SymbolFlags
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: Expression | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `symbol`: `Symbol` - `meaning`: `SymbolFlags` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `Expression | undefined`
(symbol-to-parameter-declaration type-checker symbol)
(symbol-to-parameter-declaration type-checker symbol enclosing-declaration)
(symbol-to-parameter-declaration type-checker
symbol
enclosing-declaration
flags)
Note that the resulting nodes cannot be checked.
Parameters:
symbol
: Symbol
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: ParameterDeclaration | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `symbol`: `Symbol` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `ParameterDeclaration | undefined`
(symbol-to-string type-checker symbol)
(symbol-to-string type-checker symbol enclosing-declaration)
(symbol-to-string type-checker symbol enclosing-declaration meaning)
(symbol-to-string type-checker symbol enclosing-declaration meaning flags)
Parameters:
symbol
: Symbol
enclosing-declaration
: Node | undefined
meaning
: SymbolFlags | undefined
flags
: SymbolFormatFlags | undefined
Returns: string
**Parameters:** - `symbol`: `Symbol` - `enclosing-declaration`: `Node | undefined` - `meaning`: `SymbolFlags | undefined` - `flags`: `SymbolFormatFlags | undefined` **Returns:** `string`
(symbol-to-type-parameter-declarations type-checker symbol)
(symbol-to-type-parameter-declarations type-checker
symbol
enclosing-declaration)
(symbol-to-type-parameter-declarations type-checker
symbol
enclosing-declaration
flags)
Note that the resulting nodes cannot be checked.
Parameters:
symbol
: Symbol
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: NodeArray<TypeParameterDeclaration> | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `symbol`: `Symbol` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `NodeArray<TypeParameterDeclaration> | undefined`
(symbols-in-scope type-checker location meaning)
Parameters:
location
: Node
meaning
: SymbolFlags
Returns: Symbol[]
**Parameters:** - `location`: `Node` - `meaning`: `SymbolFlags` **Returns:** `Symbol[]`
(symbols-of-parameter-property-declaration type-checker
parameter
parameter-name)
Parameters:
parameter
: ParameterDeclaration
parameter-name
: string
Returns: Symbol[]
**Parameters:** - `parameter`: `ParameterDeclaration` - `parameter-name`: `string` **Returns:** `Symbol[]`
(try-get-member-in-module-exports type-checker member-name module-symbol)
Parameters:
member-name
: string
module-symbol
: Symbol
Returns: Symbol | undefined
**Parameters:** - `member-name`: `string` - `module-symbol`: `Symbol` **Returns:** `Symbol | undefined`
(tuple-type? type-checker type)
True if this type is a tuple type. This function will not return true if passed a type which extends from a tuple.
Parameters:
type
: Type
Returns: boolean
True if this type is a tuple type. This function will _not_ return true if passed a type which extends from a tuple. **Parameters:** - `type`: `Type` **Returns:** `boolean`
(type-arguments type-checker type)
Parameters:
type
: TypeReference
Returns: readonly Type[]
**Parameters:** - `type`: `TypeReference` **Returns:** `readonly Type[]`
(type-assignable-to? type-checker source target)
Returns true if the "source" type is assignable to the "target" type.
declare const abcLiteral: ts.Type; // Type of "abc"
declare const stringType: ts.Type; // Type of string
isTypeAssignableTo(abcLiteral, abcLiteral); // true; "abc" is assignable to "abc"
isTypeAssignableTo(abcLiteral, stringType); // true; "abc" is assignable to string
isTypeAssignableTo(stringType, abcLiteral); // false; string is not assignable to "abc"
isTypeAssignableTo(stringType, stringType); // true; string is assignable to string
Parameters:
source
: Type
target
: Type
Returns: boolean
Returns true if the "source" type is assignable to the "target" type. ```ts declare const abcLiteral: ts.Type; // Type of "abc" declare const stringType: ts.Type; // Type of string isTypeAssignableTo(abcLiteral, abcLiteral); // true; "abc" is assignable to "abc" isTypeAssignableTo(abcLiteral, stringType); // true; "abc" is assignable to string isTypeAssignableTo(stringType, abcLiteral); // false; string is not assignable to "abc" isTypeAssignableTo(stringType, stringType); // true; string is assignable to string ``` **Parameters:** - `source`: `Type` - `target`: `Type` **Returns:** `boolean`
(type-at-location type-checker node)
Parameters:
node
: Node
Returns: Type
**Parameters:** - `node`: `Node` **Returns:** `Type`
(type-from-type-node type-checker node)
Parameters:
node
: TypeNode
Returns: Type
**Parameters:** - `node`: `TypeNode` **Returns:** `Type`
(type-of-assignment-pattern type-checker pattern)
Parameters:
pattern
: AssignmentPattern
Returns: Type
**Parameters:** - `pattern`: `AssignmentPattern` **Returns:** `Type`
(type-of-symbol type-checker symbol)
Parameters:
symbol
: Symbol
Returns: Type
**Parameters:** - `symbol`: `Symbol` **Returns:** `Type`
(type-of-symbol-at-location type-checker symbol node)
Parameters:
symbol
: Symbol
node
: Node
Returns: Type
**Parameters:** - `symbol`: `Symbol` - `node`: `Node` **Returns:** `Type`
(type-parameter-to-declaration type-checker parameter)
(type-parameter-to-declaration type-checker parameter enclosing-declaration)
(type-parameter-to-declaration type-checker
parameter
enclosing-declaration
flags)
Note that the resulting nodes cannot be checked.
Parameters:
parameter
: TypeParameter
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: TypeParameterDeclaration | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `parameter`: `TypeParameter` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `TypeParameterDeclaration | undefined`
(type-predicate-of-signature type-checker signature)
Parameters:
signature
: Signature
Returns: TypePredicate | undefined
**Parameters:** - `signature`: `Signature` **Returns:** `TypePredicate | undefined`
(type-predicate-to-string type-checker predicate)
(type-predicate-to-string type-checker predicate enclosing-declaration)
(type-predicate-to-string type-checker predicate enclosing-declaration flags)
Parameters:
predicate
: TypePredicate
enclosing-declaration
: Node | undefined
flags
: TypeFormatFlags | undefined
Returns: string
**Parameters:** - `predicate`: `TypePredicate` - `enclosing-declaration`: `Node | undefined` - `flags`: `TypeFormatFlags | undefined` **Returns:** `string`
(type-to-string type-checker type)
(type-to-string type-checker type enclosing-declaration)
(type-to-string type-checker type enclosing-declaration flags)
Parameters:
type
: Type
enclosing-declaration
: Node | undefined
flags
: TypeFormatFlags | undefined
Returns: string
**Parameters:** - `type`: `Type` - `enclosing-declaration`: `Node | undefined` - `flags`: `TypeFormatFlags | undefined` **Returns:** `string`
(type-to-type-node type-checker type)
(type-to-type-node type-checker type enclosing-declaration)
(type-to-type-node type-checker type enclosing-declaration flags)
Note that the resulting nodes cannot be checked.
Parameters:
type
: Type
enclosing-declaration
: Node | undefined
flags
: NodeBuilderFlags | undefined
Returns: TypeNode | undefined
Note that the resulting nodes cannot be checked. **Parameters:** - `type`: `Type` - `enclosing-declaration`: `Node | undefined` - `flags`: `NodeBuilderFlags | undefined` **Returns:** `TypeNode | undefined`
(undefined-symbol? type-checker symbol)
Parameters:
symbol
: Symbol
Returns: boolean
**Parameters:** - `symbol`: `Symbol` **Returns:** `boolean`
(undefined-type type-checker)
Gets the intrinsic undefined
type. There are multiple types that act as undefined
used internally in the compiler
depending on compiler options, so the type returned by this function should not be used in equality checks to determine
if another type is undefined
. Instead, use type.flags & TypeFlags.Undefined
.
Returns: Type
Gets the intrinsic `undefined` type. There are multiple types that act as `undefined` used internally in the compiler depending on compiler options, so the type returned by this function should not be used in equality checks to determine if another type is `undefined`. Instead, use `type.flags & TypeFlags.Undefined`. **Returns:** `Type`
(unknown-symbol? type-checker symbol)
Parameters:
symbol
: Symbol
Returns: boolean
**Parameters:** - `symbol`: `Symbol` **Returns:** `boolean`
(valid-property-access? type-checker node property-name)
Parameters:
node
: PropertyAccessExpression | QualifiedName | ImportTypeNode
property-name
: string
Returns: boolean
**Parameters:** - `node`: `PropertyAccessExpression | QualifiedName | ImportTypeNode` - `property-name`: `string` **Returns:** `boolean`
(widened-type type-checker type)
Parameters:
type
: Type
Returns: Type
**Parameters:** - `type`: `Type` **Returns:** `Type`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close