Options
All
  • Public
  • Public/Protected
  • All
Menu

Obtains option values from typedoc.json or typedoc.js (discouraged since ~0.14, don't fully deprecate until API has stabilized)

Hierarchy

  • TypeDocReader

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

name

name: string = "typedoc-json"

The name of this reader so that it may be removed by plugins without the plugin accessing the instance performing the read. Multiple readers may have the same name.

priority

priority: number = 100

Should run before the tsconfig reader so that it can specify a tsconfig file to read.

Methods

Private findTypedocFile

  • findTypedocFile(path: string): undefined | string
  • Search for the typedoc.js or typedoc.json file from the given path

    Parameters

    • path: string

      Path to the typedoc.(js|json) file. If path is a directory typedoc file will be attempted to be found at the root of this path

    Returns undefined | string

    the typedoc.(js|json) file path or undefined

read

  • read(container: Options, logger: Logger): void

Private readFile

  • readFile(file: string, container: Options & { setValue: any }, logger: Logger, seen: Set<string>): void

Generated using TypeDoc