Interface SymbolConstructor

Package version

Hierarchy

SymbolConstructor

Callable

__call(description?: string | number): symbol

- Defined in opt/hostedtoolcache/node/12.18.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.d.ts:25
Returns a new unique Symbol value.

Parameters
- Optional description: string | number
  
  Description of the new Symbol object.
Returns symbol

Index

Properties

Methods

for
keyFor

Properties

asyncIterator

asyncIterator: symbol

A method that returns the default async iterator for an object. Called by the semantics of the for-await-of statement.

iterator

iterator: symbol

A method that returns the default iterator for an object. Called by the semantics of the for-of statement.

prototype

prototype: Symbol

A reference to the prototype.

Methods

for

for(key: string): symbol

- Defined in opt/hostedtoolcache/node/12.18.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.d.ts:38
Returns a Symbol object from the global symbol registry matching the given key if found. Otherwise, returns a new symbol with this key.

Parameters
- key: string
  
  key to search for.
Returns symbol

keyFor

keyFor(sym: symbol): string | undefined

- Defined in opt/hostedtoolcache/node/12.18.1/x64/lib/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.d.ts:45
Returns a key from the global symbol registry matching the given Symbol if found. Otherwise, returns a undefined.

Parameters
- sym: symbol
  
  Symbol to find the key for.
Returns string | undefined

Generated using TypeDoc