Enumeration EntryPointStrategy

Defines how entry points are interpreted.

Enumeration Members

Expand: "expand"

The default behavior in v0.21 and earlier. Behaves like the resolve behavior, but will recursively expand directories into an entry point for each file within the directory.

LegacyPackages: "legacy-packages"

Will be removed in 0.25, this was called packages mode in 0.24. Alternative resolution mode useful for monorepos. With this mode, TypeDoc will look for a package.json and tsconfig.json under each provided entry point. The main field of each package will be documented.

Merge: "merge"

Merges multiple previously generated output from TypeDoc's --json output together into a single project.

Packages: "packages"

Run TypeDoc in each directory passed as an entry point. Once all directories have been converted, use the merge option to produce final output.

Resolve: "resolve"

The default behavior in v0.22+, expects all provided entry points as being part of a single program. Any directories included in the entry point list will result in dir/index.([cm][tj]s|[tj]sx?) being used.

Generated using TypeDoc