Adds an option declaration to the container with extra type checking to ensure that the runtime type is consistent with the declared type.
The option declaration that should be added.
Adds an option declaration to the container.
The option declaration that should be added.
Adds the given declarations to the container
Adds the option declarations declared by the TypeDoc and all supported TypeScript declarations.
Adds an option reader that will be used to read configuration values from the command line, configuration files, or other locations.
Marks the options as readonly, enables caching when fetching options, which improves performance.
Gets the set compiler options.
Gets a declaration by one of its names.
Gets all declared options.
Gets the file names discovered through reading a tsconfig file.
Gets the project references - used in solution style tsconfig setups.
Gets all of the TypeDoc option values defined in this option container.
Gets a value for the given option key, throwing if the option has not been declared.
Checks if the options object has been frozen, preventing future changes to option values.
Checks if the given option's value is deeply strict equal to the default.
Removes a declared option. WARNING: This is probably a bad idea. If you do this you will probably cause a crash when code assumes that an option that it declared still exists.
Removes all readers of a given name.
Resets the option bag to all default values. If a name is provided, will only reset that name.
Sets the compiler options that will be used to get a TS program.
Sets the logger used when an option declaration fails to be added.
Sets the given declared option. Throws if setting the option fails.
the directory to resolve Path type values against
Generated using TypeDoc
Maintains a collection of option declarations split into TypeDoc options and TypeScript options. Ensures options are of the correct type for calling code.
Option Discovery
Since plugins commonly add custom options, and TypeDoc does not permit options which have not been declared to be set, options must be read twice. The first time options are read, a noop logger is passed so that any errors are ignored. Then, after loading plugins, options are read again, this time with the logger specified by the application.
Options are read in a specific order.