BC-Envelope-CLI TypeScript Library - v1.0.0-alpha.16
    Preparing search index...

    Interface CommandArgs

    Command arguments for the format command.

    interface CommandArgs {
        type: FormatType;
        hideNodes: boolean;
        digestFormat: DigestFormatType;
        theme: MermaidThemeType;
        orientation: MermaidOrientationType;
        monochrome: boolean;
        envelope?: string;
    }
    Index

    Properties

    type hideNodes digestFormat theme orientation monochrome envelope?

    Properties

    type: FormatType

    Output format type

    hideNodes: boolean

    For tree and mermaid, hides the NODE case and digests

    digestFormat: DigestFormatType

    For tree, specifies the format for displaying digests

    theme: MermaidThemeType

    For mermaid, specifies the color theme of the diagram

    orientation: MermaidOrientationType

    For mermaid, specifies the orientation of the diagram

    monochrome: boolean

    For mermaid, do not color the nodes or edges

    envelope?: string

    The envelope to format

    Settings

    Member Visibility

    On This Page

    Properties