Class DocumentStage

Default package stage.

Since

0.1.0-alpha

Hierarchy (View Summary)

AbstractStage<Stage.Args.Document, Stage.SubStage.Document>
- DocumentStage

Index

Config

`Static`typeDocConfig

typeDocConfig(
 stage: Stage,
): {
 alwaysCreateEntryPointModule: true;
 basePath: string;
 blockTags: [...`@${string}`[], "@source", "@TODO", "@UPGRADE"];
 cascadedModifierTags: [
 ...`@${string}`[],
 "@alpha",
 "@beta",
 "@experimental",
 "@internal",
 ];
 categorizeByGroup: true;
 categoryOrder: ["Documentation", "*", "Other", "Internal", "Deprecated"];
 customFooterHtml: `Copyright <a href="https://www.maddimathon.com" target="_blank">Maddi Mathon</a>, ${string}.Site generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a>.`;
 customFooterHtmlDisableWrapper: true;
 disableGit: false;
 disableSources: false;
 excludeInternal: false;
 excludeNotDocumented: false;
 excludePrivate: false;
 excludeProtected: false;
 excludeReferences: false;
 externalSymbolLinkMappings: {
 "@maddimathon/utility-typescript": {
 Classify: "https://maddimathon.github.io/utility-typescript/Types/Objects/Classify.html";
 CustomError: "https://maddimathon.github.io/utility-typescript/classes/CustomError.html";
 "CustomError.Args": "https://maddimathon.github.io/utility-typescript/classes/CustomError/Args.html";
 "CustomError.NodeCliError": "https://maddimathon.github.io/utility-typescript/classes/CustomError/NodeCliError.html";
 Json: "https://maddimathon.github.io/utility-typescript/Types/Json.html";
 "Json.PackageJson": "https://maddimathon.github.io/utility-typescript/Types/Json/PackageJson.html";
 Logger: "https://maddimathon.github.io/utility-typescript/classes/Logger.html";
 "Logger.Args": "https://maddimathon.github.io/utility-typescript/classes/Logger/Args.html";
 mergeArgs: "https://maddimathon.github.io/utility-typescript/functions/mergeArgs.html";
 MessageMaker: "https://maddimathon.github.io/utility-typescript/classes/MessageMaker.html";
 "MessageMaker.BulkMsgArgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/BulkMsgArgs.html";
 "MessageMaker.BulkMsgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/BulkMsgs.html";
 "MessageMaker.Colour": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/Colour.html";
 "MessageMaker.MsgArgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/MsgArgs.html";
 node: "https://maddimathon.github.io/utility-typescript/classes/node.html";
 "node.NodeConsole": "https://maddimathon.github.io/utility-typescript/classes/node/NodeConsole.html";
 "node.NodeFiles": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles.html";
 "node.NodeFiles.Args": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/Args.html";
 "node.NodeFiles.CopyFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/CopyFileArgs.html";
 "node.NodeFiles.ReadDirArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadDirArgs.html";
 "node.NodeFiles.ReadFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadFileArgs.html";
 "node.NodeFiles.WriteFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/WriteFileArgs.html";
 NodeConsole: "https://maddimathon.github.io/utility-typescript/classes/node/NodeConsole.html";
 NodeFiles: "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles.html";
 "NodeFiles.Args": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/Args.html";
 "NodeFiles.CopyFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/CopyFileArgs.html";
 "NodeFiles.ReadDirArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadDirArgs.html";
 "NodeFiles.ReadFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadFileArgs.html";
 "NodeFiles.WriteFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/WriteFileArgs.html";
 Objects: "https://maddimathon.github.io/utility-typescript/Types/Objects.html";
 "Objects.Classify": "https://maddimathon.github.io/utility-typescript/Types/Objects/Classify.html";
 "Objects.RecursivePartial": "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursivePartial.html";
 "Objects.RecursiveRequired": "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursiveRequired.html";
 PackageJson: "https://maddimathon.github.io/utility-typescript/Types/Json/PackageJson.html";
 RecursivePartial: "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursivePartial.html";
 RecursiveRequired: "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursiveRequired.html";
 VariableInspector: "https://maddimathon.github.io/utility-typescript/classes/VariableInspector.html";
 };
 glob: {
 GlobOptions: "https://github.com/search?q=repo%3Aisaacs%2Fnode-glob+path%3A%2F%5Esrc%5C%2F%2F+symbol%3AGlobOptions&type=code";
 };
 global: {
 "Error.name": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name";
 };
 minify: {
 Options: "https://github.com/search?q=repo%3ADefinitelyTyped%2FDefinitelyTyped+path%3A%2F%5Etypes%5C%2Fminify%5C%2F%2F+symbol%3AOptions&type=code";
 };
 prettier: { Options: "https://prettier.io/docs/options" };
 typescript: {
 Awaited: "https://www.typescriptlang.org/docs/handbook/utility-types.html#awaitedtype";
 Capitalize: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 ConstructorParameters: "https://www.typescriptlang.org/docs/handbook/utility-types.html#constructorparameterstype";
 Error: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error";
 "Error.cause": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause";
 "Error.name": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name";
 Exclude: "https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers";
 Extract: "https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union";
 InstanceType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#instancetypetype";
 Lowercase: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 NoInfer: "https://www.typescriptlang.org/docs/handbook/utility-types.html#noinfertype";
 NonNullable: "https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype";
 Omit: "https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys";
 OmitThisParameter: "https://www.typescriptlang.org/docs/handbook/utility-types.html#omitthisparametertype";
 Parameters: "https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype";
 Partial: "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype";
 Pick: "https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys";
 Promise: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise";
 Record: "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type";
 RegExp: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp";
 Required: "https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype";
 ReturnType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype";
 ThisParameterType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#thisparametertypetype";
 ThisType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype";
 Uncapitalize: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 Uppercase: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 };
 };
 githubPages: true;
 groupOrder: [
 "*",
 "Documents",
 "Constructors",
 "Properties",
 "Accessors",
 "Functions",
 "Methods",
 "Classes",
 "Interfaces",
 "Type Aliases",
 "Namespaces",
 "Modules",
 ];
 groupReferencesByType: true;
 hideGenerator: true;
 highlightLanguages: [
 ...BundledLanguage[],
 "astro",
 "csv",
 "handlebars",
 "jsx",
 "latex",
 "markdown",
 "md",
 "php",
 "regex",
 "regexp",
 "sass",
 "scss",
 "sh",
 "shell",
 "shellscript",
 "sql",
 "swift",
 ];
 hostedBaseUrl: undefined
 | string;
 includeVersion: false;
 jsDocCompatibility: { exampleTag: false };
 kindSortOrder: [
 "Module",
 "Constructor",
 "Property",
 "Variable",
 "Function",
 "Accessor",
 "Method",
 "Enum",
 "EnumMember",
 "Class",
 "Interface",
 "TypeAlias",
 "TypeLiteral",
 "Namespace",
 "Reference",
 "Project",
 ];
 markdownLinkExternal: true;
 name: string;
 navigationLinks: { [key: string]: string };
 notRenderedTags: [...`@${string}`[], "@TODO", "@UPGRADE"];
 out: "docs";
 plugin: ["typedoc-plugin-inline-sources"];
 projectDocuments: ["README.md"];
 readme: "none";
 router: "structure";
 searchInComments: true;
 searchInDocuments: true;
 sort: [
 "documents-first",
 "static-first",
 "required-first",
 "kind",
 "visibility",
 "alphabetical",
 ];
 sourceLinkExternal: true;
 sourceLinkTemplate: | `undefined/blob/main/${string}{path}#L{line}`
 | `${string}/blob/main/${string}{path}#L{line}`;
 tsconfig: string;
 useFirstParagraphOfCommentAsSummary: true;
 visibilityFilters: {
 "@alpha": boolean;
 "@beta": true;
 external: true;
 inherited: true;
 private: boolean;
 protected: true;
 };
}
Returns a default TypeDoc configuration object. For use as Stage.Args.Document.typeDoc.
Parameters
- stage: Stage
Returns {
 alwaysCreateEntryPointModule: true;
 basePath: string;
 blockTags: [...`@${string}`[], "@source", "@TODO", "@UPGRADE"];
 cascadedModifierTags: [
 ...`@${string}`[],
 "@alpha",
 "@beta",
 "@experimental",
 "@internal",
 ];
 categorizeByGroup: true;
 categoryOrder: ["Documentation", "*", "Other", "Internal", "Deprecated"];
 customFooterHtml: `Copyright <a href="https://www.maddimathon.com" target="_blank">Maddi Mathon</a>, ${string}.Site generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a>.`;
 customFooterHtmlDisableWrapper: true;
 disableGit: false;
 disableSources: false;
 excludeInternal: false;
 excludeNotDocumented: false;
 excludePrivate: false;
 excludeProtected: false;
 excludeReferences: false;
 externalSymbolLinkMappings: {
 "@maddimathon/utility-typescript": {
 Classify: "https://maddimathon.github.io/utility-typescript/Types/Objects/Classify.html";
 CustomError: "https://maddimathon.github.io/utility-typescript/classes/CustomError.html";
 "CustomError.Args": "https://maddimathon.github.io/utility-typescript/classes/CustomError/Args.html";
 "CustomError.NodeCliError": "https://maddimathon.github.io/utility-typescript/classes/CustomError/NodeCliError.html";
 Json: "https://maddimathon.github.io/utility-typescript/Types/Json.html";
 "Json.PackageJson": "https://maddimathon.github.io/utility-typescript/Types/Json/PackageJson.html";
 Logger: "https://maddimathon.github.io/utility-typescript/classes/Logger.html";
 "Logger.Args": "https://maddimathon.github.io/utility-typescript/classes/Logger/Args.html";
 mergeArgs: "https://maddimathon.github.io/utility-typescript/functions/mergeArgs.html";
 MessageMaker: "https://maddimathon.github.io/utility-typescript/classes/MessageMaker.html";
 "MessageMaker.BulkMsgArgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/BulkMsgArgs.html";
 "MessageMaker.BulkMsgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/BulkMsgs.html";
 "MessageMaker.Colour": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/Colour.html";
 "MessageMaker.MsgArgs": "https://maddimathon.github.io/utility-typescript/classes/MessageMaker/MsgArgs.html";
 node: "https://maddimathon.github.io/utility-typescript/classes/node.html";
 "node.NodeConsole": "https://maddimathon.github.io/utility-typescript/classes/node/NodeConsole.html";
 "node.NodeFiles": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles.html";
 "node.NodeFiles.Args": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/Args.html";
 "node.NodeFiles.CopyFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/CopyFileArgs.html";
 "node.NodeFiles.ReadDirArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadDirArgs.html";
 "node.NodeFiles.ReadFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadFileArgs.html";
 "node.NodeFiles.WriteFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/WriteFileArgs.html";
 NodeConsole: "https://maddimathon.github.io/utility-typescript/classes/node/NodeConsole.html";
 NodeFiles: "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles.html";
 "NodeFiles.Args": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/Args.html";
 "NodeFiles.CopyFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/CopyFileArgs.html";
 "NodeFiles.ReadDirArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadDirArgs.html";
 "NodeFiles.ReadFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/ReadFileArgs.html";
 "NodeFiles.WriteFileArgs": "https://maddimathon.github.io/utility-typescript/classes/node/NodeFiles/WriteFileArgs.html";
 Objects: "https://maddimathon.github.io/utility-typescript/Types/Objects.html";
 "Objects.Classify": "https://maddimathon.github.io/utility-typescript/Types/Objects/Classify.html";
 "Objects.RecursivePartial": "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursivePartial.html";
 "Objects.RecursiveRequired": "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursiveRequired.html";
 PackageJson: "https://maddimathon.github.io/utility-typescript/Types/Json/PackageJson.html";
 RecursivePartial: "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursivePartial.html";
 RecursiveRequired: "https://maddimathon.github.io/utility-typescript/Types/Objects/RecursiveRequired.html";
 VariableInspector: "https://maddimathon.github.io/utility-typescript/classes/VariableInspector.html";
 };
 glob: {
 GlobOptions: "https://github.com/search?q=repo%3Aisaacs%2Fnode-glob+path%3A%2F%5Esrc%5C%2F%2F+symbol%3AGlobOptions&type=code";
 };
 global: {
 "Error.name": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name";
 };
 minify: {
 Options: "https://github.com/search?q=repo%3ADefinitelyTyped%2FDefinitelyTyped+path%3A%2F%5Etypes%5C%2Fminify%5C%2F%2F+symbol%3AOptions&type=code";
 };
 prettier: { Options: "https://prettier.io/docs/options" };
 typescript: {
 Awaited: "https://www.typescriptlang.org/docs/handbook/utility-types.html#awaitedtype";
 Capitalize: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 ConstructorParameters: "https://www.typescriptlang.org/docs/handbook/utility-types.html#constructorparameterstype";
 Error: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error";
 "Error.cause": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause";
 "Error.name": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name";
 Exclude: "https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers";
 Extract: "https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union";
 InstanceType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#instancetypetype";
 Lowercase: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 NoInfer: "https://www.typescriptlang.org/docs/handbook/utility-types.html#noinfertype";
 NonNullable: "https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype";
 Omit: "https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys";
 OmitThisParameter: "https://www.typescriptlang.org/docs/handbook/utility-types.html#omitthisparametertype";
 Parameters: "https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype";
 Partial: "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype";
 Pick: "https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys";
 Promise: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise";
 Record: "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type";
 RegExp: "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp";
 Required: "https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype";
 ReturnType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype";
 ThisParameterType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#thisparametertypetype";
 ThisType: "https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype";
 Uncapitalize: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 Uppercase: "https://www.typescriptlang.org/docs/handbook/utility-types.html#intrinsic-string-manipulation-types";
 };
 };
 githubPages: true;
 groupOrder: [
 "*",
 "Documents",
 "Constructors",
 "Properties",
 "Accessors",
 "Functions",
 "Methods",
 "Classes",
 "Interfaces",
 "Type Aliases",
 "Namespaces",
 "Modules",
 ];
 groupReferencesByType: true;
 hideGenerator: true;
 highlightLanguages: [
 ...BundledLanguage[],
 "astro",
 "csv",
 "handlebars",
 "jsx",
 "latex",
 "markdown",
 "md",
 "php",
 "regex",
 "regexp",
 "sass",
 "scss",
 "sh",
 "shell",
 "shellscript",
 "sql",
 "swift",
 ];
 hostedBaseUrl: undefined
 | string;
 includeVersion: false;
 jsDocCompatibility: { exampleTag: false };
 kindSortOrder: [
 "Module",
 "Constructor",
 "Property",
 "Variable",
 "Function",
 "Accessor",
 "Method",
 "Enum",
 "EnumMember",
 "Class",
 "Interface",
 "TypeAlias",
 "TypeLiteral",
 "Namespace",
 "Reference",
 "Project",
 ];
 markdownLinkExternal: true;
 name: string;
 navigationLinks: { [key: string]: string };
 notRenderedTags: [...`@${string}`[], "@TODO", "@UPGRADE"];
 out: "docs";
 plugin: ["typedoc-plugin-inline-sources"];
 projectDocuments: ["README.md"];
 readme: "none";
 router: "structure";
 searchInComments: true;
 searchInDocuments: true;
 sort: [
 "documents-first",
 "static-first",
 "required-first",
 "kind",
 "visibility",
 "alphabetical",
 ];
 sourceLinkExternal: true;
 sourceLinkTemplate: | `undefined/blob/main/${string}{path}#L{line}`
 | `${string}/blob/main/${string}{path}#L{line}`;
 tsconfig: string;
 useFirstParagraphOfCommentAsSummary: true;
 visibilityFilters: {
 "@alpha": boolean;
 "@beta": true;
 external: true;
 inherited: true;
 private: boolean;
 protected: true;
 };
}
- Defined in lib/03-stages/classes/DocumentStage.ts:70

`Readonly`args

args: Stage.Args.Document

A completed args object for this instance.

`Readonly`clr

clr: Colour

Colour used for colour-coding this stage.

`Readonly`config

config: Config.Class

Complete project configuration.

`Readonly`name

name: string

Name for this stage used for notices.

`Readonly`params

params: Params

Current CLI params.

ARGS_DEFAULT

get ARGS_DEFAULT(): {
 entryPoints: null;
 replace: (
 _stage: Stage,
 ) => { current: string[]; ignore: string[]; package: string[] };
 typeDoc: (
 _stage: Stage,
 ) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>;
 utils: {};
}
Default args for this stage.

Returns {
 entryPoints: null;
 replace: (
 _stage: Stage,
 ) => { current: string[]; ignore: string[]; package: string[] };
 typeDoc: (
 _stage: Stage,
 ) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>;
 utils: {};
}
- ReadonlyentryPoints: null
- replace: (_stage: Stage) => { current: string[]; ignore: string[]; package: string[] }
- ReadonlytypeDoc: (_stage: Stage) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>
 This is DocumentStage.typeDocConfig.
- Readonlyutils: {}
Overrides AbstractStage.ARGS_DEFAULT
- Defined in lib/03-stages/classes/DocumentStage.ts:398

releaseDir

get releaseDir(): string
Path to release directory for building a package for the current version.

Returns string
Inherited from AbstractStage.releaseDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:197

buildArgs

buildArgs(
args?: Partial<Stage.Args.Document>,
): Stage.Args.Document & Partial<Stage.Args.Document>
Builds a complete version of this class' args, falling back to defaults as needed.

Uses mergeArgs recursively.
Parameters
- args: Partial<Stage.Args.Document> = {}
Returns Stage.Args.Document & Partial<Stage.Args.Document>
Overrides AbstractStage.buildArgs
- Defined in lib/03-stages/classes/DocumentStage.ts:435

getDistDir

getDistDir(subDir?: DistDirectory, ...subpaths: string[]): string
Gets the paths from the config for the given dist sub directory.
Parameters
- OptionalsubDir: DistDirectory
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string
Inherited from AbstractStage.getDistDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:578

getScriptsPath

getScriptsPath(subDir?: "logs", ...subpaths: string[]): string
Gets an absolute path to the Config.Paths.scripts directories.
Parameters
- OptionalsubDir: "logs"
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string
Inherited from AbstractStage.getScriptsPath
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:590

getSrcDir

getSrcDir(subDir: SourceDirectory, ...subpaths: string[]): string[]
If there's a subdir, the return will be an array of strings.
Parameters
- subDir: SourceDirectory
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string[]
Inherited from AbstractStage.getSrcDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:597
getSrcDir(subDir?: undefined, ...subpaths: string[]): string
If there's no subdir, the return will be a string.
Parameters
- OptionalsubDir: undefined
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string
Inherited from AbstractStage.getSrcDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:602

isSubStageIncluded

isSubStageIncluded(subStage: Stage.SubStage.Document, level: number): boolean
Whether the given substage should be run according to the values of CLI.Params.only and CLI.Params.without.
Parameters
- subStage: Stage.SubStage.Document
  Substage to check.
- level: number
  Depth level for this message.
Returns boolean
Whether to run this sub-stage.
Inherited from AbstractStage.isSubStageIncluded
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:485

Constructor

constructor

new DocumentStage(
 config: Config.Class,
 params: Params,
 args: Partial<Stage.Args.Document>,
 pkg?: PackageJson,
 version?: SemVer,
): DocumentStage
Parameters
- config: Config.Class
 Current project config.
- params: Params
 Current CLI params.
- args: Partial<Stage.Args.Document>
 Partial overrides for the default args.
- Optionalpkg: PackageJson
 Parsed contents of the project’s package.json file.
- Optionalversion: SemVer
 Version object for the project’s version.
Returns DocumentStage
Overrides AbstractStage.constructor
- Defined in lib/03-stages/classes/DocumentStage.ts:470

Errors

logError

logError(
    logMsg: string,
    error: unknown,
    level: number,
    errMsg?: string,
    date?: Date,
): BulkMsgs
Alias for internal.logError.
Parameters
- logMsg: string
  Message to prepend to the return for output to the console.
- error: unknown
  Caught error to log.
- level: number
  Depth level for output to the console.
- OptionalerrMsg: string
  See logError.Args.errMsg.
- Optionaldate: Date
  Used for the timestamp.
Returns BulkMsgs
Inherited from AbstractStage.logError
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:656

writeLog

writeLog(
    msg: string | string[] | BulkMsgs,
    filename: string,
    subDir?: string[],
    date?: null | Date,
): string | false
Alias for internal.writeLog.
Parameters
- msg: string | string[] | BulkMsgs
  Log message to write.
- filename: string
  File name for the log.
- subDir: string[] = []
  Subdirectories used for the path to write the log file.
- date: null | Date = null
  Used for the timestamp.
Returns string | false
If false, writing the log failed. Otherwise, this is the path to the written log file.
Inherited from AbstractStage.writeLog
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:457

`Protected`atry

atry<T_Params extends never[], T_Return extends unknown>(
 tryer: () => Promise<T_Return>,
 level: number,
 params?: NoInfer<T_Params>,
 handlerArgs?: Partial<AbstractError.Handler.Args> & { exitProcess?: false },
): Promise<T_Return>
Experimental
If the tryer function has no params, then they are optional.

If the handler must exit, then 'FAILED' is not possible.
Type Parameters
- T_Params extends never[]
- T_Return extends unknown
Parameters
- tryer: () => Promise<T_Return>
 Function to run inside the try {}.
- level: number
 Depth level for the error handler.
- Optionalparams: NoInfer<T_Params>
 Parameters passed to the tryer function, if any.
- OptionalhandlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess?: false }
Returns Promise<T_Return>
The tryer function’s return, or 'FAILED' if an error is caught and the process isn’t exited.
Inherited from AbstractStage.atry
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:794
atry<T_Params extends unknown[], T_Return extends unknown>(
 tryer: (...params: T_Params) => Promise<T_Return>,
 level: number,
 params: NoInfer<T_Params>,
 handlerArgs?: Partial<AbstractError.Handler.Args> & { exitProcess?: false },
): Promise<T_Return>
Experimental
If the tryer function has params, then they are required.

If the handler must exit, then 'FAILED' is not possible.
Type Parameters
- T_Params extends unknown[]
- T_Return extends unknown
Parameters
- tryer: (...params: T_Params) => Promise<T_Return>
- level: number
- params: NoInfer<T_Params>
- OptionalhandlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess?: false }
Returns Promise<T_Return>
Inherited from AbstractStage.atry
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:809
atry<T_Params extends never[], T_Return extends unknown>(
 tryer: () => Promise<T_Return>,
 level: number,
 params: undefined | NoInfer<T_Params>,
 handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean },
): Promise<"FAILED" | T_Return>
Experimental
If the tryer function has no params, then they are optional.

If the handler won't exit, then 'FAILED' is possible.
Type Parameters
- T_Params extends never[]
- T_Return extends unknown
Parameters
- tryer: () => Promise<T_Return>
- level: number
- params: undefined | NoInfer<T_Params>
- handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean }
Returns Promise<"FAILED" | T_Return>
Inherited from AbstractStage.atry
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:824
atry<T_Params extends unknown[], T_Return extends unknown>(
 tryer: (...params: T_Params) => Promise<T_Return>,
 level: number,
 params: NoInfer<T_Params>,
 handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean },
): Promise<"FAILED" | T_Return>
Experimental
If the tryer function has params, then they are required.
Type Parameters
- T_Params extends unknown[]
- T_Return extends unknown
Parameters
- tryer: (...params: T_Params) => Promise<T_Return>
- level: number
- params: NoInfer<T_Params>
- handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean }
Returns Promise<"FAILED" | T_Return>
Inherited from AbstractStage.atry
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:837

`Protected`handleError

handleError(
 error: any,
 level: number,
 args?: Partial<AbstractError.Handler.Args>,
): void
Alias for errorHandler.
Parameters
- error: any
 Error to handle.
- level: number
 Depth level for output to the console.
- Optionalargs: Partial<AbstractError.Handler.Args>
 Overrides for default options.
Returns void
Inherited from AbstractStage.handleError
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:631

`Protected`try

try<T_Params extends never[], T_Return extends unknown>(
 tryer: () => T_Return,
 level: number,
 params?: NoInfer<T_Params>,
 handlerArgs?: Partial<AbstractError.Handler.Args> & { exitProcess?: false },
): T_Return
Experimental
If the tryer function has no params, then they are optional.

If the handler must exit, then 'FAILED' is not possible.
Type Parameters
- T_Params extends never[]
- T_Return extends unknown
Parameters
- tryer: () => T_Return
 Function to run inside the try {}.
- level: number
 Depth level for the error handler.
- Optionalparams: NoInfer<T_Params>
 Parameters passed to the tryer function, if any.
- OptionalhandlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess?: false }
Returns T_Return
The tryer function’s return, or 'FAILED' if an error is caught and the process isn’t exited.
Inherited from AbstractStage.try
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:690
try<T_Params extends unknown[], T_Return extends unknown>(
 tryer: (...params: T_Params) => T_Return,
 level: number,
 params: NoInfer<T_Params>,
 handlerArgs?: Partial<AbstractError.Handler.Args> & { exitProcess?: false },
): T_Return
Experimental
If the tryer function has params, then they are required.

If the handler must exit, then 'FAILED' is not possible.
Type Parameters
- T_Params extends unknown[]
- T_Return extends unknown
Parameters
- tryer: (...params: T_Params) => T_Return
- level: number
- params: NoInfer<T_Params>
- OptionalhandlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess?: false }
Returns T_Return
Inherited from AbstractStage.try
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:705
try<T_Params extends never[], T_Return extends unknown>(
 tryer: () => T_Return,
 level: number,
 params: undefined | NoInfer<T_Params>,
 handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean },
): T_Return | "FAILED"
Experimental
If the tryer function has no params, then they are optional.

If the handler won't exit, then 'FAILED' is possible.
Type Parameters
- T_Params extends never[]
- T_Return extends unknown
Parameters
- tryer: () => T_Return
- level: number
- params: undefined | NoInfer<T_Params>
- handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean }
Returns T_Return | "FAILED"
Inherited from AbstractStage.try
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:720
try<T_Params extends unknown[], T_Return extends unknown>(
 tryer: (...params: T_Params) => T_Return,
 level: number,
 params: NoInfer<T_Params>,
 handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean },
): T_Return | "FAILED"
Experimental
If the tryer function has params, then they are required.
Type Parameters
- T_Params extends unknown[]
- T_Return extends unknown
Parameters
- tryer: (...params: T_Params) => T_Return
- level: number
- params: NoInfer<T_Params>
- handlerArgs: Partial<AbstractError.Handler.Args> & { exitProcess: boolean }
Returns T_Return | "FAILED"
Inherited from AbstractStage.try
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:733

Project

isDraftVersion

get isDraftVersion(): boolean
Wheather the current project version is a draft (e.g., this is not a non-dryrun release).

Returns boolean
Inherited from AbstractStage.isDraftVersion
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:342

pkg

get pkg(): {
    bin: undefined
    | string
    | { [key: string]: string };
    bugs: undefined | { email?: string; url?: string };
    config: undefined | { [key: string | number]: any };
    description: undefined | string;
    engines: undefined | { [key: string]: string };
    files: undefined | string[];
    homepage: undefined | string;
    license: undefined | string;
    main: undefined | string;
    name: string;
    repository: undefined | string;
    version: string;
}
Current value of the package.json file for this project.

Returns {
    bin: undefined | string | { [key: string]: string };
    bugs: undefined | { email?: string; url?: string };
    config: undefined | { [key: string | number]: any };
    description: undefined | string;
    engines: undefined | { [key: string]: string };
    files: undefined | string[];
    homepage: undefined | string;
    license: undefined | string;
    main: undefined | string;
    name: string;
    repository: undefined | string;
    version: string;
}
Inherited from AbstractStage.pkg
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:152

version

get version(): SemVer
Current version object for the project.

Returns SemVer
Inherited from AbstractStage.version
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:228
set version(input: undefined | string | SemVer): void
If undefined, nothing is set. Otherwise, a SemVer is created and the value of AbstractStage.pkg.version is updated.
Parameters
- input: undefined | string | SemVer
Returns void
Inherited from AbstractStage.version
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:241

Running

`Readonly`subStages

subStages: Stage.SubStage.Document[] = ...

All sub-stages to run in this stage (in order).

Source

    public readonly subStages: Stage.SubStage.Document[] = [
        'typeDoc',
        'replace',
    ];

run

run(): Promise<void>
Runs the entire stage (asynchronously).

This method should probably not be overwritten, except in completely custom class implementations.

Cycles through each substage and runs AbstractStage.runSubStage if AbstractStage.isSubStageIncluded returns true.

Returns Promise<void>
Inherited from AbstractStage.run
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:938

startEndNotice

startEndNotice(
which: null | "start" | "end",
watcherVersion?: boolean,
): void | Promise<void>
Prints a message to the console signalling the start or end of this build stage.
Parameters
- which: null | "start" | "end"
 Whether we are starting or ending.
- watcherVersion: boolean = false
 Whether to display the watcher version of the message if applicable. Default false.
Returns void | Promise<void>
Inherited from AbstractStage.startEndNotice
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:893

`Protected`runStage

runStage(stage: Name, level: number): Promise<void>
Runs the given stage as a sub-stage to the current one.

This method should probably not be overwritten.
Parameters
- stage: Name
 Stage to run as a substage.
 - "snapshot"
 - "compile"
 - "test"
 - "document"
 - "build"
 - "package"
 - "release"
- level: number
 Depth level for output to the console.
Returns Promise<void>
Inherited from AbstractStage.runStage
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:975

`Protected`runSubStage

runSubStage(subStage: Stage.SubStage.Document): Promise<void>
Used to run a single stage within this class; used by AbstractStage.run.
Parameters
- subStage: Stage.SubStage.Document
Returns Promise<void>
Overrides AbstractStage.runSubStage
- Defined in lib/03-stages/classes/DocumentStage.ts:490

Sub-Stages

`Protected`replace

replace(): Promise<void>
Replaces placeholders in the built files and directories.

Returns Promise<void>
- Defined in lib/03-stages/classes/DocumentStage.ts:499

`Protected`typeDoc

typeDoc(): Promise<void>
Runs TypeDoc to auto-document typescript.

Returns Promise<void>
- Defined in lib/03-stages/classes/DocumentStage.ts:527

Utilities

`Readonly`compiler

compiler: Stage_Compiler

Instance used to compile files from the src directory.

`Readonly`console

console: Stage_Console

Instance used to send messages to the console.

fs

get fs(): FileSystem
Instance used to deal with files and paths.

Returns FileSystem
Inherited from AbstractStage.fs
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:111
set fs(fs: undefined | FileSystem): void
Instance used to deal with files and paths.
Parameters
- fs: undefined | FileSystem
Returns void
Inherited from AbstractStage.fs
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:126

getSrcDir

getSrcDir(subDir: SourceDirectory, ...subpaths: string[]): string[]
If there's a subdir, the return will be an array of strings.
Parameters
- subDir: SourceDirectory
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string[]
Inherited from AbstractStage.getSrcDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:597
getSrcDir(subDir?: undefined, ...subpaths: string[]): string
If there's no subdir, the return will be a string.
Parameters
- OptionalsubDir: undefined
  Sub-path to get.
- ...subpaths: string[]
  Optional additional subpaths.
Returns string
Inherited from AbstractStage.getSrcDir
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:602

replaceInFiles

replaceInFiles(
    globs: string[],
    version: "package" | "current",
    level: number,
    ignore?: string[],
    docsMode?: boolean,
): string[]
Replaces placeholders in files as defined by Config.replace.
Parameters
- globs: string[]
  Where to find & replace placeholders.
- version: "package" | "current"
  Which version of the replacements to run.
- level: number
  Depth level for output to the console.
- ignore: string[] = []
  Globs to ignore while replacing. Default FileSystem.globs.SYSTEM.
- docsMode: boolean = false
  Whether to make the replacements in 'docs' mode (i.e., assumes markdown in comments was converted to HTML).
Returns string[]
Paths where placeholders were replaced.
Inherited from AbstractStage.replaceInFiles
- Defined in lib/03-stages/classes/abstract/AbstractStage.ts:360

Class DocumentStage

Since

Hierarchy (View Summary)

Index

Config

Constructor

Errors

Project

Running

Sub-Stages

Utilities

Config

StatictypeDocConfig

Parameters

Readonlyargs

Readonlyclr

Readonlyconfig

Readonlyname

Readonlyparams

ARGS_DEFAULT

Returns { entryPoints: null; replace: ( _stage: Stage, ) => { current: string[]; ignore: string[]; package: string[] }; typeDoc: ( _stage: Stage, ) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>; utils: {};}

ReadonlyentryPoints: null

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

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

Readonlyutils: {}

releaseDir

Returns string

buildArgs

Parameters

Returns Stage.Args.Document & Partial<Stage.Args.Document>

getDistDir

Parameters

Returns string

getScriptsPath

Parameters

Returns string

getSrcDir

Parameters

Returns string[]

Parameters

Returns string

isSubStageIncluded

Parameters

Returns boolean

Constructor

constructor

Parameters

Returns DocumentStage

Errors

logError

Parameters

Returns BulkMsgs

writeLog

Parameters

Returns string | false

Protectedatry

Type Parameters

Parameters

Returns Promise<T_Return>

Type Parameters

Parameters

Returns Promise<T_Return>

Type Parameters

Parameters

Returns Promise<"FAILED" | T_Return>

Type Parameters

Parameters

Returns Promise<"FAILED" | T_Return>

ProtectedhandleError

Parameters

Returns void

Protectedtry

Type Parameters

Parameters

Returns T_Return

Type Parameters

Parameters

Returns T_Return

Type Parameters

Parameters

`Static`typeDocConfig

`Readonly`args

`Readonly`clr

`Readonly`config

`Readonly`name

`Readonly`params

Returns {
entryPoints: null;
replace: (
_stage: Stage,
) => { current: string[]; ignore: string[]; package: string[] };
typeDoc: (
_stage: Stage,
) => Partial<Omit<typeDoc.TypeDocOptions, "entryPoints">>;
utils: {};
}

`Readonly`entryPoints: null

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

`Readonly`utils: {}

`Protected`atry

`Protected`handleError

`Protected`try

`Readonly`subStages

`Protected`runStage

`Protected`runSubStage

`Protected`replace

`Protected`typeDoc

`Readonly`compiler

`Readonly`console