[I] Checker

Properties

Property	Modifier	Type
`anyType`	`readonly`	`UnknownType`
`errorType`	`readonly`	`ErrorType`
`neverType`	`readonly`	`NeverType`
`nullType`	`readonly`	`NullType`
`typePrototype`	`public`	`TypePrototype`
`voidType`	`readonly`	`VoidType`

Methods

checkProgram()

checkProgram(): void

Returns

void

checkSourceFile()

checkSourceFile(file): void

Parameters

Parameter	Type
`file`	`TypeSpecScriptNode`

Returns

void

cloneType()

cloneType<T>(type, additionalProps?): T

Type Parameters

Type Parameter
`T` extends `Type`

Parameters

Parameter	Type
`type`	`T`
`additionalProps`?	{ [P in string \| number \| symbol]?: T[P] }

Returns

T

createAndFinishType()

createAndFinishType<T>(typeDef): T & TypePrototype

Type Parameters

Type Parameter
`T` extends `CreateTypeProps`

Parameters

Parameter	Type
`typeDef`	`T`

Returns

T & TypePrototype

createFunctionType()

createFunctionType(fn): FunctionType

Parameters

Parameter	Type
`fn`	(…`args`) => `Type`

Returns

FunctionType

createLiteralType()

Call Signature

createLiteralType(value, node?): StringLiteral

Parameters

Parameter	Type
`value`	`string`
`node`?	`StringLiteralNode`

Returns

StringLiteral

Call Signature

createLiteralType(value, node?): NumericLiteral

Parameters

Parameter	Type
`value`	`number`
`node`?	`NumericLiteralNode`

Returns

NumericLiteral

Call Signature

createLiteralType(value, node?): BooleanLiteral

Parameters

Parameter	Type
`value`	`boolean`
`node`?	`BooleanLiteralNode`

Returns

BooleanLiteral

Call Signature

createLiteralType(value, node?):
  | BooleanLiteral
  | NumericLiteral
  | StringLiteral

Parameters

Parameter	Type
`value`	`string` \| `number` \| `boolean`
`node`?	\| `StringLiteralNode` \| `NumericLiteralNode` \| `BooleanLiteralNode`

Returns

| BooleanLiteral | NumericLiteral | StringLiteral

Call Signature

createLiteralType(value, node?):
  | BooleanLiteral
  | NumericLiteral
  | StringLiteral

Parameters

Parameter	Type
`value`	`string` \| `number` \| `boolean`
`node`?	\| `StringLiteralNode` \| `NumericLiteralNode` \| `BooleanLiteralNode`

Returns

| BooleanLiteral | NumericLiteral | StringLiteral

createType()

createType<T>(typeDef): T & TypePrototype & object

Type Parameters

Type Parameter
`T` extends `CreateTypeProps`

Parameters

Parameter	Type
`typeDef`	`T`

Returns

T & TypePrototype & object

evalProjection()

evalProjection(
   node,
   target,
   args): Type

Parameters

Parameter	Type
`node`	`ProjectionNode`
`target`	`Type`
`args`	`Type`[]

Returns

Type

finishType()

finishType<T>(typeDef): T

Type Parameters

Type Parameter
`T` extends `Type`

Parameters

Parameter	Type
`typeDef`	`T`

Returns

T

getGlobalNamespaceType()

getGlobalNamespaceType(): Namespace

Returns

Namespace

getLiteralType()

Call Signature

getLiteralType(node): StringLiteral

Parameters

Parameter	Type
`node`	`StringLiteralNode`

Returns

StringLiteral

Call Signature

getLiteralType(node): NumericLiteral

Parameters

Parameter	Type
`node`	`NumericLiteralNode`

Returns

NumericLiteral

Call Signature

getLiteralType(node): BooleanLiteral

Parameters

Parameter	Type
`node`	`BooleanLiteralNode`

Returns

BooleanLiteral

Call Signature

getLiteralType(node): LiteralType

Parameters

Parameter	Type
`node`	`LiteralNode`

Returns

LiteralType

getNamespaceString()

getNamespaceString(type, options?): string

Parameters

Parameter	Type
`type`	`undefined` \| `Namespace`
`options`?	`TypeNameOptions`

Returns

string

Deprecated

use import { getNamespaceFullName } from "@typespec/compiler";

getStdType()

getStdType<T>(name): StdTypes[T]

Std type

Type Parameters

Type Parameter
`T` extends \| `"Array"` \| `IntrinsicScalarName` \| `"Record"`

Parameters

Parameter	Type	Description
`name`	`T`	Name

Returns

StdTypes[T]

getTypeForNode()

getTypeForNode(node): Type

Parameters

Parameter	Type
`node`	`Node`

Returns

Type

getTypeName()

getTypeName(type, options?): string

Parameters

Parameter	Type
`type`	`Type`
`options`?	`TypeNameOptions`

Returns

string

Deprecated

use import { getTypeName } from "@typespec/compiler";

getValueExactType()

getValueExactType(value): undefined | Type

Return the exact type of a value.

const a: string = "hello";

calling getValueExactType on the value of a would give the string literal “hello”.

Parameters

Parameter	Type	Description
`value`	`Value`

Returns

undefined | Type

isStdType()

Call Signature

isStdType(type, stdType?): type is Scalar & { name: IntrinsicScalarName }

Check if the given type is one of the built-in standard TypeSpec Types.

Parameters

Parameter	Type	Description
`type`	`Scalar`	Type to check
`stdType`?	`IntrinsicScalarName`	If provided check is that standard type

Returns

type is Scalar & { name: IntrinsicScalarName }

Call Signature

isStdType(type, stdType?): type is Type & { name: "Array" | IntrinsicScalarName | "Record" }

Parameters

Parameter	Type
`type`	`Type`
`stdType`?	\| `"Array"` \| `IntrinsicScalarName` \| `"Record"`

Returns

type is Type & { name: “Array” | IntrinsicScalarName | “Record” }

isTypeAssignableTo()

isTypeAssignableTo(
   source,
   target,
   diagnosticTarget): [boolean, readonly Diagnostic[]]

Check if the source type can be assigned to the target type.

Parameters

Parameter	Type	Description
`source`	`Entity`	Source type, should be assignable to the target.
`target`	`Entity`	Target type
`diagnosticTarget`	`DiagnosticTarget`	Target for the diagnostic, unless something better can be inferred.

Returns

[boolean, readonly Diagnostic[]]

[related, list of diagnostics]

project()

project(
   target,
   projection,
   args?): Type

Parameters

Parameter	Type
`target`	`Type`
`projection`	`ProjectionNode`
`args`?	(`string` \| `number` \| `boolean` \| `Type`)[]

Returns

Type

resolveCompletions()

resolveCompletions(node): Map<string, TypeSpecCompletionItem>

Parameters

Parameter	Type
`node`	`IdentifierNode`

Returns

Map<string, TypeSpecCompletionItem>

resolveIdentifier()

resolveIdentifier(node): undefined | Sym

Parameters

Parameter	Type
`node`	`IdentifierNode`

Returns

undefined | Sym

resolveTypeReference()

resolveTypeReference(node): [undefined | Type, readonly Diagnostic[]]

Check and resolve a type for the given type reference node.

Parameters

Parameter	Type	Description
`node`	`TypeReferenceNode`	Node.

Returns

[undefined | Type, readonly Diagnostic[]]

Resolved type and diagnostics if there was an error.