OutputSymbol

An output symbol is a named entity that can be referenced in your output code.

Members

__v_skip	boolean
[inspect.custom]	() => string
constructor	(name: string | Namekey, spaces: OutputSpace[] | OutputSpace | undefined, options: OutputSymbolOptions)	Constructs a new instance of the OutputSymbol class
aliasTarget	OutputSymbol | undefined	The symbol that this symbol is an alias for.
binder	Binder | undefined	The binder that is tracking this symbol.
copy	() => OutputSymbol	Create a clone of this symbol whose name and flags reactively track the original.
copyMembersTo	(targetSymbol: OutputSymbol) => void	Copy the members of this symbol to the target symbol. This is reactive - whenever a member is added to this symbol, it will be copied to the target symbol.
copyToSpace	(space: OutputSpace) => OutputSymbol	Copy this symbol into the given space. Calls [unresolved link] and places the result in space, then returns the copy.
dealias	() => OutputSymbol	If this symbol is an alias for another symbol, return the the aliased symbol. Otherwise, return this symbol.
debugInfo	Record<string, unknown>
delete	() => void
protected getCopyOptions	() => { binder: Binder | undefined; aliasTarget: OutputSymbol | undefined; metadata: Record<string, unknown>; transient: boolean; }
hasTypeSymbol	boolean	Whether this symbol has its symbol representing its type available.
id	number	The unique id of this symbol.
ignoreNameConflict	boolean	Whether the name of this symbol bypasses the active name conflict resolution. When true, the name of this symbol will be fixed, though it may conflict with other symbols which are also ignoring name conflict resolution.
ignoreNamePolicy	boolean	Whether the name of this symbol bypasses the active name policy. When true, the name of this symbol will be fixed, though it may conflict with other symbols which are also ignoring the name policy.
protected initializeCopy	(copy: OutputSymbol) => void	Wires up reactive member-space copying and name tracking from this symbol to its copy.
isAlias	boolean	Whether this symbol is an alias for another symbol.
isMemberSymbol	boolean	Whether this symbol is a member of another symbol.
isMoved	boolean	Whether this symbol’s members have been moved to another symbol.
isTransient	boolean	Whether this symbol is a transient symbol. Transient symbols cannot be referenced and are meant to be combined with other symbols.
isTyped	boolean	Whether this symbol’s members are provided by a type symbol. The typeSymbol property is this symbol. It may not be available yet, so check hasTypeSymbol.
memberSpaceFor	(spaceKey: string) => OutputMemberSpace | undefined	Get the member space for the given key.
memberSpaces	OutputMemberSpace[]	The member spaces of this symbol.
memberSpaces	Readonly<string[]>	The member space keys for this symbol type. Subclasses override this to declare which member spaces are created on construction (e.g., ["static", "instance"]).
metadata	Record<string, unknown>	An arbitrary bag of metadata for this symbol. This property is read only, but the metadata is a reactive object.
movedTo	OutputSymbol | undefined	The symbol that this symbol’s members have been moved to.
moveMembersTo	(targetSymbol: OutputSymbol) => void	Move member symbols from this transient symbol to the target symbol. This is reactive - whenever a member is added to this symbol, it will be moved to the target symbol.
name	string	The name of this symbol. Assigning to this property applies the active name policy (unless ignoreNamePolicy is true) before storing the value.
namePolicy	NamePolicyGetter | undefined
originalName	string	Read only. The requested name of this symbol. The symbol’s actual name may be different depending on naming policy or conflicts with other symbols.
ownerSymbol	OutputSymbol | undefined	When this is a member symbol, this returns the symbol that this is symbol is a member of.
refkeys	Refkey[]	The refkeys for this symbol.
resolveMemberByName	(name: string) => OutputSymbol | undefined	Get a member symbol by name from this symbol’s member spaces. Checks member spaces in order until it finds a member with that name.
scope	import(”./output-scope.js”).OutputScope | undefined	The scope this symbol is in. When this symbol is a member symbol, this will return undefined.
spaces	OutputSpace[]	The declaration or member spaces this symbol belongs to.
toString	() => string
type	OutputSymbol | undefined	The symbol which defines the type of this symbol. The type symbol provides information about the value this symbol contains, such as what members it has.

Remarks

This is an abstract base class. Language packages must subclass it and implement the abstract copy() method, which creates a clone that tracks the original’s name and flags.

Subtypes typically add language-specific properties (e.g., accessibility, static/abstract flags). Symbols are reactive values, so you can observe changes to their properties in a reactive context.

To construct a scopeless external library symbol — one that resolves via refkey but does not appear in any declaration space — pass undefined as the spaces constructor argument and supply { binder } in options. See OutputSymbolOptions (binder option) and TO_SYMBOL.

Example

import { createSymbol, OutputSymbol, OutputSpace } from "@alloy-js/core";

class MySymbol extends OutputSymbol {
  copy() {
    // getCopyOptions() already includes binder
    const opts = this.getCopyOptions();
    const sym = createSymbol(MySymbol, this.name, undefined, opts);
    this.initializeCopy(sym);
    return sym;
  }
}

// name: string | Namekey; spaces: OutputSpace | OutputSpace[] | undefined; options: OutputSymbolOptions
const sym = createSymbol(MySymbol, namekey, scope.symbols, { binder });

// Construct a scopeless external library symbol (resolves via refkey only):
const extSym = createSymbol(MySymbol, namekey, undefined, { binder });