Module specta::js_doc

Available on crate features js_doc and typescript only.

JSDoc helpers.

Also requires typescript feature to be enabled.

Modules

• comments
• formatter

Structs

• Builder
• CommentFormatterArgs
• ExportConfig
  Options for controlling the behavior of the Typescript exporter.
• ExportPath
  Represents the path of an error in the export tree. This is designed to be opaque, meaning it’s internal format and Display impl are subject to change at will.

Enums

• BigIntExportBehavior
  Allows you to configure how Specta’s Typescript exporter will deal with BigInt types (i64, i128 etc).
• ExportError
  The error type for the TypeScript exporter.
• NamedLocation
  Describes where an error occurred.

Functions

• datatype
  Convert a DataType to a TypeScript string
• export
  Convert a type which implements Type to a TypeScript string with an export.
• export_function_headerfunction
  Convert a [FunctionDataType] into a function header like would be used in a .d.ts file. If your function requires a function body you can copy this function into your own codebase.
• export_named_datatype
  Convert a DataType to a TypeScript string
• export_ref
  Convert a type which implements Type to a TypeScript string with an export.
• inline
  Convert a type which implements Type to a TypeScript string.
• inline_ref
  Convert a type which implements Type to a TypeScript string.
• typedef_named_datatype

Type Aliases

• CommentFormatterFn
  The signature for a function responsible for exporting Typescript comments.
• FormatterFn
  The signature for a function responsible for formatter a Typescript file.
• Result