Struct specta_typescript::ExportConfig

pub struct ExportConfig { /* private fields */ }

Options for controlling the behavior of the Typescript exporter.

Implementations

impl ExportConfig

pub fn new() -> Self

Construct a new ExportConfiguration

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

Configure the BigInt handling behaviour

pub fn comment_style(self, exporter: Option<CommentFormatterFn>) -> Self

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: FormatterFn) -> Self

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

Implementations:

• prettier
• ESLint

pub fn run_format(&self, path: PathBuf) -> Result<()>

Run the specified formatter on the given path.

Trait Implementations

impl Clone for ExportConfig

fn clone(&self) -> ExportConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExportConfig

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

Formats the value using the given formatter.

impl Default for ExportConfig

fn default() -> Self

Returns the “default value” for a type.