Struct typescript_type_def::DefinitionFileOptions

pub struct DefinitionFileOptions<'a> {
    pub header: Option<&'a str>,
    pub root_namespace: &'a str,
}

Options for customizing the output of write_definition_file.

The default options are:

DefinitionFileOptions {
    header: Some("// AUTO-GENERATED by typescript-type-def\n"),
    root_namespace: "types",
}

Fields

header: Option<&'a str>

Text to be emitted at the start of the file.

If Some, the string should contain the exact content of the header as TypeScript code (usually in the form of comments). If None, no header will be added.

root_namespace: &'a str

The name of the root namespace which the definitions will be placed under.

The reason all definitions must be placed under a root namespace is to prevent name ambiguities. Consider the following TypeScript module:

type Foo = number;
export namespace foo {
    type Foo = string;
    type Bar = { x: Foo };
}

In this case, the type that Bar.x refers to is ambiguous; it could be either the top-level Foo or the adjacent Foo. Placing all types under a namespace and referencing them by full path removes this ambiguity:

export namespace root {
    type Foo = number;
    export namespace foo {
        type Foo = string;
        type Bar = { x: root.Foo };
    }
}

Trait Implementations

impl<'a> Clone for DefinitionFileOptions<'a>

fn clone(&self) -> DefinitionFileOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DefinitionFileOptions<'a>

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

Formats the value using the given formatter.

impl Default for DefinitionFileOptions<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq<DefinitionFileOptions<'a>> for DefinitionFileOptions<'a>

fn eq(&self, other: &DefinitionFileOptions<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DefinitionFileOptions<'a>) -> bool

This method tests for !=.

impl<'a> Copy for DefinitionFileOptions<'a>

impl<'a> Eq for DefinitionFileOptions<'a>

impl<'a> StructuralEq for DefinitionFileOptions<'a>

impl<'a> StructuralPartialEq for DefinitionFileOptions<'a>