Class Configuration

Hierarchy

Configuration

Constructors

constructor

new Configuration(params?: ConfigurationParams): Configuration
Parameters
- Optional params: ConfigurationParams
Returns Configuration
- Defined in index.ts:91

Properties

`Private` #finderLayout

#finderLayout: ((fnlayout: any) => Promise<string>)

Type declaration

- (fnlayout: any): Promise<string>
- Parameters
  - fnlayout: any
  Returns Promise<string>

`Private` #finderLayoutSync

#finderLayoutSync: ((fnlayout: any) => string)

Type declaration

- (fnlayout: any): string
- Parameters
  - fnlayout: any
  Returns string

`Private` #finderPartial

#finderPartial: ((fnpartial: any) => Promise<string>)

Type declaration

- (fnpartial: any): Promise<string>
- Parameters
  - fnpartial: any
  Returns Promise<string>

`Private` #finderPartialSync

#finderPartialSync: ((fnpartial: any) => string)

Type declaration

- (fnpartial: any): string
- Parameters
  - fnpartial: any
  Returns string

`Private` #layoutDirs

#layoutDirs: any

`Private` #partial

#partial: ((fname: string, metadata: any) => Promise<string>)

Type declaration

- (fname: string, metadata: any): Promise<string>
- Parameters
  - fname: string
  - metadata: any
  Returns Promise<string>

`Private` #partialDirs

#partialDirs: any

`Private` #partialSync

#partialSync: ((fname: string, metadata: any) => string)

Type declaration

- (fname: string, metadata: any): string
- Parameters
  - fname: string
  - metadata: any
  Returns string

`Private` #renderers

#renderers: any

Accessors

layoutDirs

get layoutDirs(): string[]
Returns string[]
- Defined in index.ts:188
set layoutDirs(dirz: string[]): void
An array of absolute paths to directories containing layout templates.
Parameters
- dirz: string[]
Returns void
- Defined in index.ts:185

layoutFinder

set layoutFinder(finder: ((fnlayout: any) => Promise<string>)): void
Store a function for finding layout templates
Parameters
- finder: ((fnlayout: any) => Promise<string>)
  - - (fnlayout: any): Promise<string>
    - Parameters
      
      fnlayout: any
      
      Returns Promise<string>
Returns void
- Defined in index.ts:206

layoutFinderSync

set layoutFinderSync(finder: ((fnlayout: any) => string)): void
Store a function for finding layout templates
Parameters
- finder: ((fnlayout: any) => string)
  - - (fnlayout: any): string
    - Parameters
      
      fnlayout: any
      
      Returns string
Returns void
- Defined in index.ts:216

partialDirs

get partialDirs(): string[]
Returns string[]
- Defined in index.ts:141
set partialDirs(dirz: string[]): void
An array of absolute paths to directories containing partial templates.
Parameters
- dirz: string[]
Returns void
- Defined in index.ts:138

partialFinder

set partialFinder(finder: ((fnpartial: any) => Promise<string>)): void
Store a function for finding partial templates.
Parameters
- finder: ((fnpartial: any) => Promise<string>)
  - - (fnpartial: any): Promise<string>
    - Parameters
      
      fnpartial: any
      
      Returns Promise<string>
Returns void
- Defined in index.ts:158

partialFinderSync

set partialFinderSync(finder: ((fnpartial: any) => string)): void
Store a function for finding partial templates.
Parameters
- finder: ((fnpartial: any) => string)
  - - (fnpartial: any): string
    - Parameters
      
      fnpartial: any
      
      Returns string
Returns void
- Defined in index.ts:167

partialFunc

set partialFunc(pfunc: ((fname: string, metadata: any) => Promise<string>)): void
Parameters
- pfunc: ((fname: string, metadata: any) => Promise<string>)
  - - (fname: string, metadata: any): Promise<string>
    - Parameters
      
      fname: string
      
      metadata: any
      
      Returns Promise<string>
Returns void
- Defined in index.ts:320

partialFuncSync

set partialFuncSync(pfunc: ((fname: string, metadata: any) => string)): void
Parameters
- pfunc: ((fname: string, metadata: any) => string)
  - - (fname: string, metadata: any): string
    - Parameters
      
      fname: string
      
      metadata: any
      
      Returns string
Returns void
- Defined in index.ts:324

renderers

get renderers(): Renderer[]
Return the list of registered renderers

Returns Renderer[]
- Defined in index.ts:247

Methods

addLayoutDir

addLayoutDir(dir: string): void
Add an absolute pathname for a directory to find layout templates.
Parameters
- dir: string
Returns void
- Defined in index.ts:195

addPartialDir

addPartialDir(dir: string): void
Add an absolute pathname for a directory to find partial templates.
Parameters
- dir: string
Returns void
- Defined in index.ts:148

findLayout

findLayout(fnlayout: string): Promise<string>
Find a layout template, supporting asynchronous execution

Returns
Parameters
- fnlayout: string
Returns Promise<string>
- Defined in index.ts:228

findLayoutSync

findLayoutSync(fnlayout: string): string
Find a layout template, supporting synchronous execution

Returns
Parameters
- fnlayout: string
Returns string
- Defined in index.ts:238

findPartial

findPartial(fnpartial: string): Promise<string>
Parameters
- fnpartial: string
Returns Promise<string>
- Defined in index.ts:173

findPartialSync

findPartialSync(fnpartial: string): string
Parameters
- fnpartial: string
Returns string
- Defined in index.ts:177

findRenderer

findRenderer(name: string): Renderer
Find a Renderer by its extension.
Parameters
- name: string
Returns Renderer
- Defined in index.ts:311

findRendererName

findRendererName(name: string): Renderer
Parameters
- name: string
Returns Renderer
- Defined in index.ts:280

findRendererPath

findRendererPath(_path: string): Renderer
Parameters
- _path: string
Returns Renderer
- Defined in index.ts:287

partial

partial(fname: string, metadata: any): Promise<string>
Parameters
- fname: string
- metadata: any
Returns Promise<string>
- Defined in index.ts:328

partialSync

partialSync(fname: string, metadata: any): string
Parameters
- fname: string
- metadata: any
Returns string
- Defined in index.ts:336

registerBuiltInRenderers

registerBuiltInRenderers(): void
Returns void
- Defined in index.ts:296

registerOverrideRenderer

registerOverrideRenderer(renderer: Renderer): void
Allow an application to override one of the built-in renderers that are initialized below. The inspiration is epubtools that must write HTML files with an .xhtml extension. Therefore it can subclass EJSRenderer etc with implementations that force the file name to be .xhtml. We're not checking if the renderer name is already there in case epubtools must use the same renderer name.
Parameters
- renderer: Renderer
Returns void
- Defined in index.ts:270

registerRenderer

registerRenderer(renderer: Renderer): void
Parameters
- renderer: Renderer
Returns void
- Defined in index.ts:249