Class EsNamespace

Namespace used to resolve naming conflicts.

Hierarchy

EsNamespace

Implements

EsNamingHost

Index

Constructors

constructor

new EsNamespace(scope, init?): EsNamespace
Constructs namespace.
Parameters
- scope: EsScope
  
  Code emission scope the namespace created for.
- Optional init: EsNamespaceInit
  
  Initialization options.
Returns EsNamespace
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:27

Accessors

comment

get comment(): EsComment
Namespace comment.

Returns EsComment
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:83

enclosing

get enclosing(): undefined | EsNamespace
Enclosing namespace, or undefined for top-level one.

Returns undefined | EsNamespace
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:69

names

get names(): EsNameRegistry
Name registry used to reserve names.

Returns EsNameRegistry
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:76

ns

get ns(): this
Always refers itself.

Returns this
Implementation of EsNamingHost.ns
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:55

scope

get scope(): EsScope
Code emission scope this namespace created for.

Returns EsScope
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:62

Methods

addSymbol

addSymbol<TNaming>(symbol, createNaming): TNaming
Registers symbol within namespace and assigns a name for it.

The symbol will be visible within namespace itself and its nested ones.

Called by symbol declaration method.
Type Parameters
- TNaming extends EsNaming
  
  Type of symbol naming.
Parameters
- symbol: EsSymbol<TNaming>
  
  Symbol to bind.
- createNaming: ((naming) => TNaming)
  
  Naming factory function that accepts partial symbol naming.
  - - (naming): TNaming
    - Parameters
      
      naming: EsNaming
      
      Returns TNaming
Returns TNaming
Symbol naming.

Throws
TypeError if the symbol is already named within another namespace.
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:126

encloses

encloses(ns): boolean
Checks whether this namespace encloses another one.
Parameters
- ns: EsNamespace
  
  Namespace to checks.
Returns boolean
true if the given namespace is nested within this namespace or any namespaces nested within it, or false otherwise.
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:95

findSymbol

findSymbol<TNaming>(ref): undefined | TNaming
Searches for the symbol named in this namespace or one of enclosing namespaces.
Type Parameters
- TNaming extends EsNaming
  
  Type of symbol naming.
Parameters
- ref: EsReference<TNaming, EsSymbol<TNaming>>
  
  Reference to target symbol.
Returns undefined | TNaming
Either found symbol naming, or undefined when symbol is not visible.
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:226

nest

nest(scope, init?): EsNamespace
Creates nested namespace.
Parameters
- scope: EsScope
  
  Code emission scope the nested namespace created for.
- Optional init: Omit<EsNamespaceInit, "enclosing">
  
  Nested namespace initialization options.
Returns EsNamespace
New namespace nested within current one.
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:383

refer

refer<TNaming>(ref): EsResolution<TNaming, EsSymbol<TNaming>>
Refers the symbol visible in this namespace.
Type Parameters
- TNaming extends EsNaming
  
  Type of symbol naming.
Parameters
- ref: EsReference<TNaming, EsSymbol<TNaming>>
  
  Reference to symbol previously named in this namespace or one of enclosing ones.
Returns EsResolution<TNaming, EsSymbol<TNaming>>
Referred symbol naming.
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:277

toString

toString(): string
Returns string
- Defined in ucnot/esgen/src/symbols/es-namespace.ts:387

Class EsNamespace

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

scope: EsScope

Optional init: EsNamespaceInit

Returns EsNamespace

Accessors

comment

Returns EsComment

enclosing

Returns undefined | EsNamespace

names

Returns EsNameRegistry

ns

Returns this

scope

Returns EsScope

Methods

addSymbol

Type Parameters

TNaming extends EsNaming

Parameters

symbol: EsSymbol<TNaming>

createNaming: ((naming) => TNaming)

Parameters

naming: EsNaming

Returns TNaming

Returns TNaming

Throws

encloses

Parameters

ns: EsNamespace

Returns boolean

findSymbol

Type Parameters

TNaming extends EsNaming

Parameters

ref: EsReference<TNaming, EsSymbol<TNaming>>

Returns undefined | TNaming

nest

Parameters

scope: EsScope

Optional init: Omit<EsNamespaceInit, "enclosing">

Returns EsNamespace

refer

Type Parameters

TNaming extends EsNaming

Parameters

ref: EsReference<TNaming, EsSymbol<TNaming>>

Returns EsResolution<TNaming, EsSymbol<TNaming>>

toString

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` init: EsNamespaceInit

`Optional` init: Omit<EsNamespaceInit, "enclosing">