Class DocSet

constructor

• new DocSet(config, plugins, docs): DocSet

• Parameters

  • config: DjockeyConfigResolved
  • plugins: DjockeyPlugin[]
  • docs: DjockeyDoc[]

  Returns DocSet

config

docs

plugins

tree

getDoc

• getDoc(refPath): null | DjockeyDoc

• Parameters

  • refPath: string

  Returns null | DjockeyDoc

makeRenderableCopy

• makeRenderableCopy(renderer, logCollector): DjockeyDoc[]

• Parameters

  • renderer: DjockeyRenderer
  • logCollector: LogCollector

  Returns DjockeyDoc[]

runPasses

• runPasses(logCollector): Promise<void>

• Parameters

  • logCollector: LogCollector

  Returns Promise<void>