karambit-inject
    Preparing search index...

    Interface KarambitOptions

    Configuration for component implementation generation.

    interface KarambitOptions {
        allowEmptyModules: boolean;
        allowEmptyOutput: boolean;
        dryRun: boolean;
        enableDocTags: boolean;
        exclude?: string[];
        include?: string[];
        logger?: Logger;
        nameMaxLength: number;
        outFile: string;
        outputScriptTarget: ScriptTarget;
        printerOptions?: PrinterOptions;
        verbose: boolean;
    }
    Index

    Properties

    allowEmptyModules allowEmptyOutput dryRun enableDocTags exclude? include? logger? nameMaxLength outFile outputScriptTarget printerOptions? verbose

    Properties

    allowEmptyModules: boolean

    if true, generation will succeed even if there are empty modules

    allowEmptyOutput: boolean

    if true, generation will succeed even if no component declarations were found in the input program

    dryRun: boolean

    if true, no output files will be written

    enableDocTags: boolean

    if true, enable support for doc tag annotation in addition to decorators

    exclude?: string[]

    if specified, files matching this glob pattern will not be examined (even if specified by include)

    include?: string[]

    if specified, only files matching this glob pattern will be examined

    logger?: Logger

    allows replacing the default logging with a custom logger; defaults to console

    nameMaxLength: number

    the max length of generated identifiers in output files

    outFile: string

    the destination file to write

    outputScriptTarget: ScriptTarget

    script target of the generated output TypeScript

    printerOptions?: PrinterOptions

    configuration for how the output TypeScript should be printed

    verbose: boolean

    enable verbose logging

    Settings

    Member Visibility

    On This Page

    Properties