Skip to content
Alloy
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Basic concepts
Example walkthrough
Diagnosing issues
@alloy-js/core
components
AppendFile
AppendRegion
Block
CopyFile
createAccessExpression
Declaration
For
Indent
List
MemberDeclaration
MemberName
MemberScope
Name
Output
Prose
ReferenceOrContent
Scope
Show
SourceDirectory
SourceFile
StatementList
Switch
TemplateFile
TemplateVariable
UpdateFile
Wrap
contexts
Assignment context
Binder context
Declaration context
Member context
MemberDeclaration context
NamePolicy context
Scope context
SourceDirectory context
SourceFile context
functions
attachDiagnosticsCollector
baseListPropsToMapJoinArgs
children
childrenArray
code
computed
createComment
createComponent
createContentSlot
createContext
createCustomContext
createDeclarationTap
createElement
createFileResource
createFormatOptionsContextFor
createFragment
createMemberTap
createNamedContext
createNamePolicy
createOutputBinder
createResource
createScope
createScopeTap
createSourceFileTap
createSymbol
createSymbolSlot
createTap
createTextNode
decl
defaultProps
effect
emitDiagnostic
emitDiagnosticForTree
emitSymbol
ensureIsEmpty
findCurrentEffectId
findKeyedChild
findKeyedChildren
findUnkeyedChildren
formatReactivePropertyLabel
getAssignmentSymbol
getContext
getContextForNode
getContextForRenderNode
getDiagnosticsForTree
getEffectDebugId
getReactiveCreationLocation
getRegisteredDiagnosticsForTree
getSymbolCreator
getSymbolCreatorSymbol
inspectRefkey
instantiateTakenMembersTo
isComponentCreator
isCustomContext
isKeyedChild
isLibrarySymbolReference
isMemberRefkey
isNamekey
isRefkey
isRefkeyable
isRenderableObject
isSymbolRefkey
join
mapJoin
memberRefkey
memo
mergeProps
moveTakenMembersTo
namekey
nextReactiveId
notifyContentState
onCleanup
printTree
reactivePropertyRefId
ref
refId
refkey
registerDiagnosticsForTree
render
renderAsync
renderTree
reportDiagnostics
reportDiagnosticsForTree
resetRefIdCounter
resolve
root
runInContext
shallowReactive
shallowRef
sourceFilesForTree
splitProps
stc
sti
symbolForRefkey
taggedComponent
takeSymbols
text
toRef
toRefkey
toRefs
traverseOutput
unresolvedRefkey
untrack
useContext
useFormatOptions
useMemberContext
useMemberScope
writeOutput
testing
functions
createTestWrapper
d
dedent
renderToString
types
TestWrapper
ToRenderToOptions
types
AlloyNode
AppendRegionProps
BaseListProps
BasePartProps
BasicScope
BasicSymbol
Binder
BinderOptions
Child
Children
ChildrenOptions
CommentNode
CommonFormatOptions
Component
ComponentContext
ComponentCreator
ComponentDefinition
ContentOutputFile
ContentSlot
Context
ContextProviderProps
CopyFileContext
CopyOutputFile
CustomContext
CustomContextChildrenCallback
DebugSourceLocation
DeclarationProps
Diagnostic
DiagnosticHandle
DiagnosticInput
DiagnosticsCollector
DiagnosticSeverity
DiagnosticStackEntry
Disposable_2
EffectDebugOptions
EffectOptions
ElementNode
ForCallbackArgs
ForSupportedCollections
FragmentNode
Insertable
IntrinsicElements
JoinOptions
LibrarySymbolReference
MakeChildrenOptional
MatchProps
MemberDeclarationProps
MemberDescriptor
MemberRefkey
MemberResolutionContext
MemberResolver
MemberScopeProps
Metadata
NameConflictResolver
Namekey
NamekeyOptions
NamePolicy
NamePolicyGetter
NodeType
OnReactiveSetAddCallback
OnReactiveSetDeleteCallback
OutputDeclarationSpace
OutputDirectory
OutputFile
OutputFileBase
OutputMemberSpace
OutputScope
OutputScopeOptions
OutputSpace
OutputSymbol
OutputSymbolOptions
OutputVisitor
PrintTreeOptions
Props
ReactiveUnionSet
ReactiveUnionSetOptions
Refkey
Refkeyable
RefkeyableObject
RenderableObject
RenderTreeOptions
ResolutionResult
ResolveDeclarationByKeyOptions
Resource
RootOptions
ScopeProps
SourceLocation
SplitProps
StcComponentCreator
StcSignature
StiComponentCreator
StiSignature
SymbolCreator
SymbolRefkey
SymbolSlot
SymbolTable
TakeSymbolCallback
TakeSymbolsCallback
Tap
TapHandler
Tapper
TemplateVariableProps
TextNode
variables
COMMENT_NODE
contextsByKey
ELEMENT_NODE
FormatOptions
FRAGMENT_NODE
Match
matchTag
REFKEYABLE
RENDERABLE
TEXT_NODE
TO_SYMBOL
@alloy-js/core/testing
functions
createTestWrapper
d
dedent
renderToString
types
TestWrapper
ToRenderToOptions
@alloy-js/typescript
components
ArrayExpression
ArrowFunction
BarrelFile
BlockScope
CallSignature
CaseClause
CatchClause
ClassDeclaration
ClassField
ClassMember
ClassMethod
CommaList
Declaration
ElseClause
ElseIfClause
ensureTypeRefContext
EnumDeclaration
EnumMember
ExportStatement
FinallyClause
FunctionCallExpression
FunctionDeclaration
FunctionExpression
IfStatement
ImportStatement
ImportStatements
InterfaceDeclaration
InterfaceMember
InterfaceMethod
JSDoc
JSDocComment
JSDocExample
MemberExpression
NewExpression
ObjectExpression
ObjectProperty
ObjectSpreadProperty
PackageDirectory
PackageJsonFile
SingleLineCommentBlock
SourceFile
SwitchStatement
TryStatement
TSConfigJson
ValueExpression
VarDeclaration
contexts
Package context
PackageMetadata context
SourceFile context
functions
createInstanceMemberSymbol
createLexicalScope
createMemberScope
createMemberSymbol
createPackage
createPrivateInstanceMemberSymbol
createPrivateStaticMemberSymbol
createStaticMemberSymbol
createTransientValueSymbol
createTSNamePolicy
createTypeAndValueSymbol
createTypeSymbol
createValueSymbol
decl
declMember
declType
getPackageScope
getSourceDirectoryData
ref
tsNameConflictResolver
useTSLexicalScope
useTSLexicalScopeIfPresent
useTSMemberScope
useTSNamePolicy
useTSScope
types
AddImportOptions
BlockScopeProps
CaseClauseProps
CaseClausePropsBase
CommonDeclarationProps
CreatePackageProps
CreateTsSymbolOptions
DeclarationProps
DeclarationPropsBase
ExportConditions
ExportPath
ExternalPackage
FunctionBodyProps
FunctionParametersProps
FunctionTypeParameterDescriptor
FunctionTypeParametersProps
FunctionTypeProps
ImportedSymbol
ImportRecords
InterfaceExpressionProps
InterfaceMemberProps
InterfaceMemberPropsBase
MemberExpressionPartProps
ModuleExports
ModuleSymbolsDescriptor
NamedMap
NamedModuleDescriptor
PackageDescriptor
PackageExports
PackageRefkeys
ParameterDescriptor
ParameterDescriptorBase
ReferenceProps
RefOptions
SourceDirectoryData
SourceFileHeaderProps
TSLexicalScope
TSMemberScope
TSModuleScope
TSOutputScope
TSOutputSymbol
TSPackageScope
TSPackageScopeOptions
TypeDeclarationProps
TypeParameterDescriptor
TypeParametersProps
TypeRefContextProps
TypeScriptElements
variables
FunctionType
InterfaceExpression
TSSymbolFlags
TypeDeclaration
@alloy-js/python
components
Atom
AttributeDoc
CallSignature
CallSignatureParameters
ClassDeclaration
ClassDoc
ClassEnumDeclaration
ClassInstantiation
ClassMethodDeclaration
ConstructorDeclaration
DataclassDeclaration
Declaration
DunderMethodDeclaration
EnumMember
ExceptionDoc
FunctionalEnumDeclaration
FunctionCallExpression
FunctionDeclaration
FunctionDoc
FutureStatement
GeneratorDoc
InlineDoc
LexicalScope
MemberExpression
MemberScope
MethodDeclaration
MethodDoc
ModuleDoc
PropertyDeclaration
PropertyDoc
PydanticClassDeclaration
PyDoc
PyDocExample
PythonBlock
SimpleCommentBlock
SimpleInlineComment
SourceFile
StatementList
StaticMethodDeclaration
TypeArguments
TypeReference
UnionTypeExpression
useSourceFile
VariableDeclaration
contexts
PythonSourceFile context
functions
createFunctionSymbol
createMethodSymbol
createModule
createPythonNamePolicy
getCallSignatureProps
isParameterDescriptor
isTypeRefContext
ref
usePythonLexicalScope
usePythonNamePolicy
usePythonScope
types
AddImportOptions
BaseDeclarationProps
CommonFunctionProps
CreateModuleProps
CreatePythonSymbolFunctionOptions
DataclassDecoratorKey
DataclassDecoratorKwargs
EnumPropsBase
GoogleStyleDocAttributeProps
ImportedSymbol
ImportRecordProps
ImportRecords
LexicalScopeProps
MemberExpressionPartProps
ModuleDescriptor
ModuleRefkeys
NamedMap
ParameterDescriptor
ParameterMarker
PropertyMethodDeclarationProps
PydanticModelConfigDictProps
PythonElements
PythonLexicalScope
PythonMemberScope
PythonModuleScope
PythonOutputScope
PythonOutputSymbol
PythonOutputSymbolOptions
ReferenceProps
RefOptions
SubscriptionProps
TypeRefContextProps
variables
abcModule
dataclassDecoratorKeys
dataclassDecoratorKeySet
dataclassesModule
enumModule
pydanticModule
pydanticSettingsModule
requestsModule
typingModule
@alloy-js/csharp
components
AccessExpression
AttributeList
ClassDeclaration
Constructor
CsprojFile
Declaration
DocC
DocCode
DocComment
DocDescription
DocExample
DocException
DocFromMarkdown
DocInclude
DocList
DocPara
DocParam
DocParamRef
DocPermission
DocRemarks
DocReturns
DocSee
DocSeeAlso
DocSummary
DocTypeParam
DocTypeParamRef
DocValue
DocWhen
ElseClause
ElseIfClause
EnumDeclaration
EnumMember
Field
IfStatement
InterfaceDeclaration
InterfaceMethod
InterfaceProperty
InvocationExpression
LexicalScope
Method
MethodScope
Name
Namespace
Parameter
Parameters_2
Property
RecordDeclaration
Region
SourceFile
StructDeclaration
UsingNamespaceDirective
Usings
VarDeclaration
contexts
csharp context
functions
access
accessibilityFromProps
computeModifiersPrefix
createClassScope
createCSharpNamePolicy
createCSharpNamespaceScope
createFieldSymbol
createLibrary
createMethodScope
createMethodSymbol
createNamedTypeScope
createNamedTypeSymbol
createNamespaceSymbol
createParameterSymbol
createPropertySymbol
createTypeParameterSymbol
createVariableSymbol
getAccessModifier
getAsyncModifier
isCSharpContextualKeyword
isCSharpKeyword
isValidCSharpIdentifier
makeModifiers
nonAccessibilityFromProps
ref
sanitizeCSharpIdentifier
useCsharpFormatOptions
useCSharpNamePolicy
useCSharpScope
useEnclosingNamespaceScope
useLexicalScope
useMethodScope
useNamedTypeScope
useNamespace
useSourceFileScope
types
AccessExpressionBuilder
AccessExpressionPartProps
AccessModifiers
AttributeProps
AttributesProp
ClassDescriptor
ClassModifiers
CreateMethodSymbolOptions
CreateTypeParameterSymbolOptions
CSharpClassScope
CSharpElements
CSharpFormatOptions
CSharpLexicalScope
CSharpMethodScope
CSharpNamedTypeScope
CSharpNamespaceScope
CSharpProjectSdk
CSharpScope
CSharpSourceFileScope
CSharpSymbol
CSharpSymbolKinds
CSharpSymbolOptions
DeclarationModifiers
DeclaredAccessibility
Descriptor
DocCommentTagProps
EnumDescriptor
FieldDescriptor
FieldModifiers
GenericDescriptor
InterfaceDescriptor
InterfaceMethodModifiers
InterfaceModifiers
InterfacePropertyModifiers
LexicalScopeProps
LibraryFrom
MemberDescriptor
MethodDescriptor
MethodKinds
MethodModifiers
MethodScopeProps
MethodSymbol
NamedTypeDescriptor
NamedTypeSymbol
NamedTypeSymbolKind
NamedTypeTypeKind
NamespaceDescriptor
NamespaceSymbol
NamespaceSymbolOptions
NonAccessModifiers
PropertyDescriptor_2
PropertyModifiers
RecordDescriptor
RecordModifiers
ReferenceProps
ResolveDescriptor
StructDescriptor
StructModifiers
TypeParameterProps
VarModifiers
variables
Attribute
CSharpFormatOptions
csharpKeywords
@alloy-js/go
components
BlockComment
FunctionDeclaration
FunctionParameter
FunctionParameters
FunctionReceiver
ImportStatements
InterfaceDeclaration
InterfaceEmbed
InterfaceFunction
InterfaceTypeDeclaration
LineComment
ModuleDirectory
Name
Pointer
SingleImportStatement
SourceDirectory
SourceFile
StructDeclaration
StructEmbed
StructMember
StructTypeDeclaration
TypeConstraint
TypeDeclaration
TypeDeclarationGroup
TypeParameter
TypeParameters
VariableDeclaration
VariableDeclarationGroup
contexts
TypeDeclarationGroup context
VariableDeclarationGroup context
functions
createAnonymousTypeSymbol
createFunctionScope
createFunctionSymbol
createGoModuleScope
createGoNamePolicy
createGoPackageScope
createInterfaceMemberSymbol
createModule
createNamedTypeScope
createNestedStructSymbol
createPackageSymbol
createParameterSymbol
createPropertySymbol
createStructMemberSymbol
createTypeParameterSymbol
createTypeSymbol
createVariableSymbol
ref
useEnclosingPackageScope
useFuncScope
useGoNamePolicy
useGoScope
useLexicalScope
useModule
useNamedTypeScope
usePackage
useSourceFileScope
types
CreateTypeParameterSymbolOptions
Descriptor
EmbedDescriptor
FieldDescriptor
FunctionDescriptor
FunctionSymbol
GoElements
GoFunctionScope
GoLexicalScope
GoModuleScope
GoNamedTypeScope
GoPackageScope
GoScope
GoSourceFileScope
GoSymbol
GoSymbolKinds
GoSymbolOptions
ImportRecords
InterfaceDescriptor
LibraryFrom
MemberDescriptor
MethodDescriptor
NamedTypeDescriptor
NamedTypeSymbol
NamedTypeSymbolKind
NamedTypeSymbolOptions
NamedTypeTypeKind
PackageDescriptor
PackageSymbol
PackageSymbolOptions
ReferenceProps
ResolveDescriptor
SourceFileHeaderProps
StrictDescriptor
StructDescriptor
TypeDescriptor
VariableDescriptor
variables
std
@alloy-js/java
components
Annotation
ArgumentList
Class
Constructor
Declaration
Enum
EnumMember
EnumMemberList
ExtendsClause
ImplementsClause
ImportStatement
ImportStatements
Interface
MavenProject
Method
Modifiers
Name
NamedArgumentList
ObjectDeclaration
PackageDirectory
Parameters_2
PomFileBuild
ProjectDirectory
Reference
SourceFile
TypeArguments
TypeParameters
usePackage
Value
Variable
contexts
PackageDirectory context
Project context
SourceFile context
functions
createJavaNamePolicy
createLibrary
ref
useJavaNamePolicy
useLexicalScope
types
CommonDeclarationProps
CreateLibraryProps
ExtendsTypeArgumentDescriptor
GradleProjectConfig
JavaDependency
JavaElements
JavaLexicalScope
JavaOutputScope
JavaOutputSymbol
JavaOutputSymbolOptions
JavaPackageScope
JavaProjectScope
JavaProjectScopeOptions
LibraryDescriptor
LibraryRefkeys
MavenProjectConfig
NamedTypeArgumentDescriptor
SuperTypeArgumentDescriptor
TypeArgumentDescriptor
WildcardTypeArgumentDescriptor
variables
javaUtil
@alloy-js/json
components
JsonArray
JsonArrayElement
JsonObject
JsonObjectProperty
JsonValue
Reference
SourceFile
contexts
JsonFile context
functions
ref
useJsonFileContext
types
CreateJsonSymbolOptions
JsonArrayElementProps
JsonArrayProps
JsonArrayPropsBase
JsonObjectProps
JsonObjectPropsBase
JsonOutputSymbol
ObjectPropertyProps
variables
JsonSymbolFlags
GitHub
Select theme
Dark
Light
Auto
DiagnosticStackEntry
Members
Section titled “Members”
name
string
renderNodeId
optional
number
source
optional
SourceLocation