Skip to content

createInstanceMemberSymbol

import { createInstanceMemberSymbol } from "@alloy-js/typescript";
function createInstanceMemberSymbol(name: string, options?: CreateTsSymbolOptions): TSOutputSymbol;
name

string

optionsoptional

CreateTsSymbolOptions

aliasTargetoptionalMemberDeclaration context interface

The symbol this symbol is an alias for.

binderoptionalBinder context interface

The binder instance associated with this symbol. Symbol updates and changes will be reported to this binder. This binder will be able to find this symbol via its refkey and other means. Without a binder, this symbol will be unbound, which means it cannot be referenced by refkey.

defaultoptionalboolean
exportoptionalboolean
hasInstanceMembersoptionalboolean
ignoreNameConflictoptionalboolean

Whether the name of this symbol should bypass 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.

ignoreNamePolicyoptionalboolean

Whether the name of this symbol should bypass 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.

metadataoptionalRecord<string, unknown>

Arbitrary metadata about this symbol.

namePolicyoptionalNamePolicyGetter

When provided, this symbol will be named according to the provided name policy.

refkeysoptionalRefkey | Refkey[]

The refkey or refkeys associated with this symbol.

transientoptionalboolean

Whether this symbol is transient.

tsFlagsoptionalTSSymbolFlags
typeoptionalMemberDeclaration context interface | Ref<MemberDeclaration context interface | undefined>

The symbol that provides type information for this symbol. When present, this symbol will not contain its own members, and instead members will be provided by the type. This can be provided a Ref, in which case the type will be the value of that ref.

[unresolved link]