Struct Typescript

#[non_exhaustive]
pub struct Typescript {
    pub header: Cow<'static, str>,
    pub framework_header: Cow<'static, str>,
    pub bigint: BigIntExportBehavior,
    pub comment_exporter: Option<fn(CommentFormatterArgs<'_>) -> String>,
    pub formatter: Option<fn(&Path) -> Result<(), Error>>,
}

Typescript language exporter.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

header: Cow<'static, str>

The users file header

framework_header: Cow<'static, str>

The framework’s header

bigint: BigIntExportBehavior

How BigInts should be exported.

comment_exporter: Option<fn(CommentFormatterArgs<'_>) -> String>

How comments should be rendered.

formatter: Option<fn(&Path) -> Result<(), Error>>

How the resulting file should be formatted.

Implementations

impl Typescript

pub fn new() -> Typescript

Construct a new Typescript exporter with the default options configured.

pub fn header(self, header: impl Into<Cow<'static, str>>) -> Typescript

Configure a header for the file.

This is perfect for configuring lint ignore rules or other file-level comments.

pub fn bigint(self, bigint: BigIntExportBehavior) -> Typescript

Configure the BigInt handling behaviour

pub fn comment_style( self, exporter: fn(CommentFormatterArgs<'_>) -> String, ) -> Typescript

Configure a function which is responsible for styling the comments to be exported

Implementations:

• js_doc

Not calling this method will default to the js_doc exporter. None will disable comment exporting. Some(exporter) will enable comment exporting using the provided exporter.

pub fn formatter(self, formatter: fn(&Path) -> Result<(), Error>) -> Typescript

Configure a function which is responsible for formatting the result file or files

Built-in implementations:

• prettier
• ESLint
• Biomee

pub fn export(&self, types: &TypeCollection) -> Result<String, ExportError>

TODO

pub fn export_to( &self, path: impl AsRef<Path>, types: &TypeCollection, ) -> Result<(), ExportError>

TODO

pub fn format(&self, path: impl AsRef<Path>) -> Result<(), ExportError>

TODO

Trait Implementations

impl Clone for Typescript

fn clone(&self) -> Typescript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Typescript

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

Formats the value using the given formatter.

impl Default for Typescript

fn default() -> Typescript

Returns the “default value” for a type.