Struct TsFunction 

pub struct TsFunction {
    pub name: String,
    pub parameters: Vec<TsParameter>,
    pub return_type: TsType,
    pub is_async: bool,
    pub description: Option<String>,
    pub examples: Vec<String>,
}

Function signature

Fields

name: String

Function name

parameters: Vec<TsParameter>

Parameters

return_type: TsType

Return type

is_async: bool

Is async

description: Option<String>

Description

examples: Vec<String>

Example code

Implementations

impl TsFunction

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

Creates a new function

pub fn parameter(self, param: TsParameter) -> Self

Adds a parameter

pub fn async_fn(self) -> Self

Marks as async

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

Sets a description

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

Adds an example

pub fn to_ts_declaration(&self) -> String

Generates TypeScript declaration

pub fn to_jsdoc(&self) -> String

Generates JSDoc comment

Trait Implementations

impl Clone for TsFunction

fn clone(&self) -> TsFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TsFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TsFunction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.