Struct BrandedTypeExporter 

pub struct BrandedTypeExporter<'a> {
    pub types: &'a TypeCollection,
    /* private fields */
}

Reference to Typescript language exporter for branded type callbacks.

Fields

types: &'a TypeCollection

Collected types currently being exported.

Implementations

impl BrandedTypeExporter<'_>

pub fn inline(&self, dt: &DataType) -> Result<String, Error>

primitives::inline

pub fn reference(&self, r: &Reference) -> Result<String, Error>

primitives::reference

Methods from Deref<Target = Exporter>

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

Export the files into a single string.

Note: This returns an error if the format is Format::Files.

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

Export the types to a specific file/folder.

When configured when format is Format::Files, you must provide a directory path. Otherwise, you must provide the path of a single file.

Trait Implementations

impl AsRef<Exporter> for BrandedTypeExporter<'_>

fn as_ref(&self) -> &Exporter

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for BrandedTypeExporter<'_>

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

Formats the value using the given formatter.

impl Deref for BrandedTypeExporter<'_>

type Target = Exporter

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.