Struct JSDoc

pub struct JSDoc(pub Typescript);

JSDoc language exporter.

Tuple Fields

0: Typescript

Implementations

impl JSDoc

pub fn new() -> Self

Construct a new JSDoc exporter with the default options configured.

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

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

Configure the BigInt handling behaviour

pub fn comment_style(self, exporter: 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

Built-in implementations:

• prettier
• ESLint
• Biomee

Trait Implementations

impl Clone for JSDoc

fn clone(&self) -> JSDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JSDoc

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

Formats the value using the given formatter.

impl Default for JSDoc

fn default() -> JSDoc

Returns the “default value” for a type.

impl From<Typescript> for JSDoc

fn from(ts: Typescript) -> Self

Converts to this type from the input type.

impl Language for JSDoc

type Error = ExportError

TODO

fn export(&self, _type_map: &TypeCollection) -> Result<String, Self::Error>

TODO

fn format(&self, path: &Path) -> Result<(), Self::Error>

TODO