Class ABasePluginAbstract

Hierarchy

  • ABasePlugin

Constructors

constructor

Properties

application logger optionsPrefix package pluginDir

Accessors

name rootDir

Methods

initialize relativeToRoot resolvePackageFile

Constructors

constructor

  • Instanciate a new instance of the base plugin. The package.json file will be read to obtain the plugin name & the TypeDoc compatible range. Logs a warning if the current TypeDoc version is not compatible.

    Parameters

    • application: Application

      The application instance.

    • pluginFilename: string

      The actual plugin file name. Used to lookup the package.json file.

    Returns ABasePlugin

Properties

Readonly application

application: Application

The application instance.

Readonly logger

logger: PluginLogger

Readonly optionsPrefix

optionsPrefix: string

Readonly package

package: ReadonlyObjectDeep<{
    author?: Person;
    bin?: string | Partial<Record<string, string>>;
    bugs?: BugsLocation;
    bundleDependencies?: string[];
    bundledDependencies?: string[];
    config?: JsonObject;
    contributors?: Person[];
    cpu?: LiteralUnion<"arm" | "arm64" | "ia32" | "mips" | "mipsel" | "ppc" | "ppc64" | "s390" | "s390x" | "x32" | "x64" | "!arm" | "!arm64" | "!ia32" | "!mips" | "!mipsel" | "!ppc" | "!ppc64" | "!s390" | "!s390x" | "!x32" | "!x64", string>[];
    dependencies?: Partial<Record<string, string>>;
    description?: string;
    devDependencies?: Partial<Record<string, string>>;
    directories?: DirectoryLocations;
    engineStrict?: boolean;
    engines?: {};
    exports?: Exports;
    files?: string[];
    funding?: string | {
        type?: LiteralUnion<"github" | "opencollective" | "patreon" | "individual" | "foundation" | "corporation", string>;
        url: string;
    };
    homepage?: LiteralUnion<".", string>;
    imports?: Imports;
    keywords?: string[];
    license?: string;
    licenses?: {
        type?: string;
        url?: string;
    }[];
    main?: string;
    maintainers?: Person[];
    man?: string | string[];
    name: string;
    optionalDependencies?: Partial<Record<string, string>>;
    os?: LiteralUnion<"aix" | "darwin" | "freebsd" | "linux" | "openbsd" | "sunos" | "win32" | "!aix" | "!darwin" | "!freebsd" | "!linux" | "!openbsd" | "!sunos" | "!win32", string>[];
    peerDependencies?: Partial<Record<string, string>>;
    peerDependenciesMeta?: Partial<Record<string, {
        optional: true;
    }>>;
    preferGlobal?: boolean;
    private?: boolean;
    publishConfig?: PublishConfig;
    repository?: string | {
        directory?: string;
        type: string;
        url: string;
    };
    scripts?: Scripts;
    type?: "module" | "commonjs";
    version: string;
    workspaces?: string[] | WorkspaceConfig;
}>

Readonly pluginDir

pluginDir: string

Accessors

name

rootDir

Methods

Abstract initialize

relativeToRoot

resolvePackageFile

  • Resolve the path to a plugin file (resolved from the plugin package.json).

    Returns

    the resolved path.

    Parameters

    • path: string

      The path to resolve.

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc