Struct TsClass 

pub struct TsClass {
    pub name: String,
    pub description: Option<String>,
    pub members: Vec<TsMember>,
    pub examples: Vec<String>,
}

Class definition

Fields

name: String

Class name

description: Option<String>

Description

members: Vec<TsMember>

Members

examples: Vec<String>

Examples

Implementations

impl TsClass

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

Creates a new class

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

Sets a description

pub fn member(self, member: TsMember) -> Self

Adds a member

pub fn with_example(self, example: impl Into<String>) -> Self

Adds an example

pub fn to_ts_declaration(&self) -> String

Generates TypeScript declaration

Trait Implementations

impl Clone for TsClass

fn clone(&self) -> TsClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TsClass

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TsClass

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

where __S: Serializer,

Serialize this value into the given Serde serializer.