Struct TSModuleDeclaration

#[repr(C)]
pub struct TSModuleDeclaration<'a> {
    pub span: Span,
    pub id: TSModuleDeclarationName<'a>,
    pub body: Option<TSModuleDeclarationBody<'a>>,
    pub kind: TSModuleDeclarationKind,
    pub declare: bool,
    pub scope_id: Cell<Option<ScopeId>>,
}

TypeScript Module and Namespace Declarations

Examples

declare module 'foo' {
// kind ^^^^^^ ^^^^^ id
}

namespace Foo { }
declare namespace Bar { }

declare global {
    interface Window {
       customProp: string;
    }
}

References

• TypeScript Handbook - Namespaces
• TypeScript Handbook - Module Augmentation
• TypeScript Handbook - Global Augmentation

Fields

span: Span

id: TSModuleDeclarationName<'a>

The name of the module/namespace being declared.

Note that for declare global {}, no symbol will be created for the module name.

body: Option<TSModuleDeclarationBody<'a>>

kind: TSModuleDeclarationKind

The keyword used to define this module declaration.

Helps discriminate between global overrides vs module declarations vs namespace declarations.

namespace Foo {}
^^^^^^^^^
module 'foo' {}
^^^^^^
declare global {}
        ^^^^^^

declare: bool

scope_id: Cell<Option<ScopeId>>

Implementations

impl TSModuleDeclaration<'_>

pub fn has_use_strict_directive(&self) -> bool

Returns true if this module’s body exists and has a "use strict" directive.

impl TSModuleDeclaration<'_>

pub fn scope_id(&self) -> ScopeId

Get ScopeId of TSModuleDeclaration.

Only use this method on a post-semantic AST where ScopeIds are always defined.

Panics

Panics if scope_id is None.

pub fn set_scope_id(&self, scope_id: ScopeId)

Set ScopeId of TSModuleDeclaration.

Trait Implementations

impl<'new_alloc> CloneIn<'new_alloc> for TSModuleDeclaration<'_>

type Cloned = TSModuleDeclaration<'new_alloc>

The type of the cloned object.

fn clone_in(&self, allocator: &'new_alloc Allocator) -> Self::Cloned

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> Self::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl ContentEq for TSModuleDeclaration<'_>

fn content_eq(&self, other: &Self) -> bool

This method tests for contents of self and other to be equal.

fn content_ne(&self, other: &Self) -> bool

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Debug for TSModuleDeclaration<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Dummy<'a> for TSModuleDeclaration<'a>

fn dummy(allocator: &'a Allocator) -> Self

Create a dummy TSModuleDeclaration.

Does not allocate any data into arena.

impl GetSpan for TSModuleDeclaration<'_>

fn span(&self) -> Span

Get the Span for an AST node.

impl GetSpanMut for TSModuleDeclaration<'_>

fn span_mut(&mut self) -> &mut Span

Get a mutable reference to an AST node’s Span.

impl<'a> TakeIn<'a> for TSModuleDeclaration<'a>

fn take_in(&mut self, allocator: &'a Allocator) -> Self

Replace node with a dummy.

fn take_in_box(&mut self, allocator: &'a Allocator) -> Box<'a, Self>

Replace node with a boxed dummy.