NPM Build Utilities @ 0.1.3
    Preparing search index...

    Interface Document

    The required shape for a document stage.

    DocumentStage.ARGS_DEFAULT For defaults.

    0.1.0-alpha

    interface Document {
        entryPoints: null | string[];
        replace:
            | false
            | (
                (
                    _stage: Stage,
                ) => { current?: string[]; ignore?: string[]; package?: string[] }
            );
        typeDoc:
            | Partial<Omit<TypeDocOptions, "entryPoints">>
            | (
                (
                    _stage: Stage,
                ) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>
            );
        utils: { compiler?: Stage_Compiler; fs?: FileSystem };
    }

    Hierarchy (View Summary)

    Index

    Properties

    entryPoints replace typeDoc utils

    Properties

    entryPoints: null | string[]

    Passed to typeDoc options.

    If null, entry point is taken from package.json’s main.

    replace:
        | false
        | (
            (
                _stage: Stage,
            ) => { current?: string[]; ignore?: string[]; package?: string[] }
        )

    Whether to include this sub-stage, or the configuration if so.

    typeDoc:
        | Partial<Omit<TypeDocOptions, "entryPoints">>
        | ((_stage: Stage) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>)

    Default configuration for typeDoc. Some configuration is added in DocumentStage.typeDoc.

    utils: { compiler?: Stage_Compiler; fs?: FileSystem }

    Optional class instances to use.

    Settings

    Member Visibility

    On This Page

    Properties