types

local types = require("@std/syntax/types")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
CstAttribute
CstElseIfExpr
CstElseIfStat
CstEof
CstExpr
CstExprBinary
CstExprCall
CstExprConstantBool
CstExprConstantInteger
CstExprConstantNil
CstExprConstantNumber
CstExprConstantString
CstExprFunction
CstExprGlobal
CstExprGroup
CstExprIfElse
CstExprIndexExpr
CstExprIndexName
CstExprInstantiate
CstExprInterpString
CstExprLocal
CstExprTable
CstExprTypeAssertion
CstExprUnary
CstExprVarargs
CstFunctionTypeParameter
CstGenericType
CstGenericTypePack
CstLocal
CstNode
CstStat
CstStatAssign
CstStatBlock
CstStatBreak
CstStatCompoundAssign
CstStatConst
CstStatContinue
CstStatDo
CstStatExpr
CstStatFor
CstStatForIn
CstStatFunction
CstStatIf
CstStatLocal
CstStatLocalFunction
CstStatRepeat
CstStatReturn
CstStatTypeAlias
CstStatTypeFunction
CstStatWhile
CstTableExprGeneralItem
CstTableExprItem
CstTableExprListItem
CstTableExprRecordItem
CstTableTypeItem
CstTableTypeItemIndexer
CstTableTypeItemProperty
CstTableTypeItemStringProperty
CstType
CstTypeArray
CstTypeFunction
CstTypeGroup
CstTypeIntersection
CstTypeOptional
CstTypePack
CstTypePackExplicit
CstTypePackGeneric
CstTypePackVariadic
CstTypeReference
CstTypeSingletonBool
CstTypeSingletonString
CstTypeTable
CstTypeTypeof
CstTypeUnion
MultiLineComment
ParseResult
Replacement	The type of a replacement for a CST node.
Replacements	A mapping of CST nodes to their replacements, used with @std/syntax/printer and lute transform to specify how CSTs should be mutated.
SingleLineComment
Span
Trivia
Type
TypePack
Whitespace

---

Types

CstAttribute

type CstAttribute = luau.CstAttribute

---

CstElseIfExpr

type CstElseIfExpr = luau.CstElseIfExpr

---

CstElseIfStat

type CstElseIfStat = luau.CstElseIfStat

---

CstEof

type CstEof = luau.CstEof

---

CstExpr

type CstExpr = luau.CstExpr

---

CstExprBinary

type CstExprBinary = luau.CstExprBinary

---

CstExprCall

type CstExprCall = luau.CstExprCall

---

CstExprConstantBool

type CstExprConstantBool = luau.CstExprConstantBool

---

CstExprConstantInteger

type CstExprConstantInteger = luau.CstExprConstantInteger

---

CstExprConstantNil

type CstExprConstantNil = luau.CstExprConstantNil

---

CstExprConstantNumber

type CstExprConstantNumber = luau.CstExprConstantNumber

---

CstExprConstantString

type CstExprConstantString = luau.CstExprConstantString

---

CstExprFunction

type CstExprFunction = luau.CstExprFunction

---

CstExprGlobal

type CstExprGlobal = luau.CstExprGlobal

---

CstExprGroup

type CstExprGroup = luau.CstExprGroup

---

CstExprIfElse

type CstExprIfElse = luau.CstExprIfElse

---

CstExprIndexExpr

type CstExprIndexExpr = luau.CstExprIndexExpr

---

CstExprIndexName

type CstExprIndexName = luau.CstExprIndexName

---

CstExprInstantiate

type CstExprInstantiate = luau.CstExprInstantiate

---

CstExprInterpString

type CstExprInterpString = luau.CstExprInterpString

---

CstExprLocal

type CstExprLocal = luau.CstExprLocal

---

CstExprTable

type CstExprTable = luau.CstExprTable

---

CstExprTypeAssertion

type CstExprTypeAssertion = luau.CstExprTypeAssertion

---

CstExprUnary

type CstExprUnary = luau.CstExprUnary

---

CstExprVarargs

type CstExprVarargs = luau.CstExprVarargs

---

CstFunctionTypeParameter

type CstFunctionTypeParameter = luau.CstFunctionTypeParameter

---

CstGenericType

type CstGenericType = luau.CstGenericType

---

CstGenericTypePack

type CstGenericTypePack = luau.CstGenericTypePack

---

CstLocal

type CstLocal = luau.CstLocal

---

CstNode

type CstNode = luau.CstNode

---

CstStat

type CstStat = luau.CstStat

---

CstStatAssign

type CstStatAssign = luau.CstStatAssign

---

CstStatBlock

type CstStatBlock = luau.CstStatBlock

---

CstStatBreak

type CstStatBreak = luau.CstStatBreak

---

CstStatCompoundAssign

type CstStatCompoundAssign = luau.CstStatCompoundAssign

---

CstStatConst

type CstStatConst = luau.CstStatConst

---

CstStatContinue

type CstStatContinue = luau.CstStatContinue

---

CstStatDo

type CstStatDo = luau.CstStatDo

---

CstStatExpr

type CstStatExpr = luau.CstStatExpr

---

CstStatFor

type CstStatFor = luau.CstStatFor

---

CstStatForIn

type CstStatForIn = luau.CstStatForIn

---

CstStatFunction

type CstStatFunction = luau.CstStatFunction

---

CstStatIf

type CstStatIf = luau.CstStatIf

---

CstStatLocal

type CstStatLocal = luau.CstStatLocal

---

CstStatLocalFunction

type CstStatLocalFunction = luau.CstStatLocalFunction

---

CstStatRepeat

type CstStatRepeat = luau.CstStatRepeat

---

CstStatReturn

type CstStatReturn = luau.CstStatReturn

---

CstStatTypeAlias

type CstStatTypeAlias = luau.CstStatTypeAlias

---

CstStatTypeFunction

type CstStatTypeFunction = luau.CstStatTypeFunction

---

CstStatWhile

type CstStatWhile = luau.CstStatWhile

---

CstTableExprGeneralItem

type CstTableExprGeneralItem = luau.CstTableExprGeneralItem

---

CstTableExprItem

type CstTableExprItem = luau.CstTableExprItem

---

CstTableExprListItem

type CstTableExprListItem = luau.CstTableExprListItem

---

CstTableExprRecordItem

type CstTableExprRecordItem = luau.CstTableExprRecordItem

---

CstTableTypeItem

type CstTableTypeItem = luau.CstTableTypeItem

---

CstTableTypeItemIndexer

type CstTableTypeItemIndexer = luau.CstTableTypeItemIndexer

---

CstTableTypeItemProperty

type CstTableTypeItemProperty = luau.CstTableTypeItemProperty

---

CstTableTypeItemStringProperty

type CstTableTypeItemStringProperty = luau.CstTableTypeItemStringProperty

---

CstType

type CstType = luau.CstType

---

CstTypeArray

type CstTypeArray = luau.CstTypeArray

---

CstTypeFunction

type CstTypeFunction = luau.CstTypeFunction

---

CstTypeGroup

type CstTypeGroup = luau.CstTypeGroup

---

CstTypeIntersection

type CstTypeIntersection = luau.CstTypeIntersection

---

CstTypeOptional

type CstTypeOptional = luau.CstTypeOptional

---

CstTypePack

type CstTypePack = luau.CstTypePack

---

CstTypePackExplicit

type CstTypePackExplicit = luau.CstTypePackExplicit

---

CstTypePackGeneric

type CstTypePackGeneric = luau.CstTypePackGeneric

---

CstTypePackVariadic

type CstTypePackVariadic = luau.CstTypePackVariadic

---

CstTypeReference

type CstTypeReference = luau.CstTypeReference

---

CstTypeSingletonBool

type CstTypeSingletonBool = luau.CstTypeSingletonBool

---

CstTypeSingletonString

type CstTypeSingletonString = luau.CstTypeSingletonString

---

CstTypeTable

type CstTypeTable = luau.CstTypeTable

---

CstTypeTypeof

type CstTypeTypeof = luau.CstTypeTypeof

---

CstTypeUnion

type CstTypeUnion = luau.CstTypeUnion

---

MultiLineComment

type MultiLineComment = luau.MultiLineComment

---

ParseResult

type ParseResult = luau.ParseResult

---

Replacement

The type of a replacement for a CST node.

A replacement can be:

1. A string, which will be used as the replacement text for the node, with any surrounding trivia preserved.

2. An object with a content property containing the replacement string, and an optional preserveTrivia boolean property.

If preserveTrivia is true, the replaced CST node's attached trivia (whitespace and comments) will be reserialized with the replacement content.

If false, the trivia will be discarded. If omitted, trivia is preserved by default.

Note that trailing trivia for a token consists of all whitespace and comments that follow it up to and including a newline.

Any trivia after the first seen newline is considered leading trivia for the next token.

type Replacement = string | { content: string, preserveTrivia: boolean? }

---

Replacements

A mapping of CST nodes to their replacements, used with @std/syntax/printer and lute transform to specify how CSTs should be mutated.

type Replacements = { [CstNode]: Replacement }

---

SingleLineComment

type SingleLineComment = luau.SingleLineComment

---

Span

type Span = luau.Span

---

Trivia

type Trivia = luau.Trivia

---

Type

type Type = luau.Type

---

TypePack

type TypePack = luau.TypePack

---

Whitespace

type Whitespace = luau.Whitespace

---