Struct TsModule 

pub struct TsModule {
    pub name: String,
    pub description: Option<String>,
    pub classes: Vec<TsClass>,
    pub interfaces: Vec<TsInterface>,
    pub type_aliases: Vec<TsTypeAlias>,
    pub functions: Vec<TsFunction>,
}

Module definition

Fields

name: String

Module name

description: Option<String>

Description

classes: Vec<TsClass>

Classes

interfaces: Vec<TsInterface>

Interfaces

type_aliases: Vec<TsTypeAlias>

Type aliases

functions: Vec<TsFunction>

Functions

Implementations

impl TsModule

pub fn new(name: impl Into<String>) -> Self

Creates a new module

pub fn with_description(self, description: impl Into<String>) -> Self

Sets a description

pub fn class(self, class: TsClass) -> Self

Adds a class

pub fn interface(self, interface: TsInterface) -> Self

Adds an interface

pub fn type_alias(self, alias: TsTypeAlias) -> Self

Adds a type alias

pub fn function(self, function: TsFunction) -> Self

Adds a function

pub fn to_ts_declarations(&self) -> String

Generates TypeScript declarations

Trait Implementations

impl Clone for TsModule

fn clone(&self) -> TsModule

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TsModule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TsModule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TsModule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.