Zum Hauptinhalt springen

TemplateCompiler

Constructors​

Constructor​

new TemplateCompiler(template, withData?): TemplateCompiler

Parameters​

template​

string

withData?​

object

Returns​

TemplateCompiler

Properties​

template​

template: string

data​

data: object

handlebarCompiler​

handlebarCompiler: any

Methods​

useDocFile()​

useDocFile(docFile, additionalData?): this

Use a docFile as data source

Parameters​

docFile​

DocFile

The file to use

additionalData?​

object

Optional additional data to use

Returns​

this

Memberof​

TemplateCompiler

compile()​

compile(data?, compileOptions?): string

Compiles the template by given data.

Parameters​

data?​

object

Optional additional data. If you're using data from constructor, your data will merged.

compileOptions?​

CompileOptions

Optional compiler options

Returns​

string

Memberof​

TemplateCompiler

toString()​

toString(): string

Returns​

string

fromFileCoverTemplate()​

static fromFileCoverTemplate(docFile, fileCoverOptions?): TemplateCompiler

Creates a new instance of TemplateCompiler by using the template FileCover.

If no fileCoverOptions provided, only the fields in FileCover will be displayed.

Parameters​

docFile​

DocFile

The docFile to use as data source

fileCoverOptions?​

FileCoverTemplateOptions

Returns​

TemplateCompiler

fromDocFile()​

static fromDocFile(docFile, templateOrFilePath, additionalData?): TemplateCompiler

Creates a new instance of TemplateCompiler with data from docFile and given template

Parameters​

docFile​

DocFile

The docFile to use as data source

templateOrFilePath​

string

The template as string to compile.

additionalData?​

object

Optional data

Returns​

TemplateCompiler

Static​

Memberof​

TemplateCompiler

fromDocFileWithDocumentTemplate()​

static fromDocFileWithDocumentTemplate(docFile, templateName, additionalData?): TemplateCompiler

Creates a new instance of TemplateCompiler with data from docFile and given document template name (Dokumentenvorlage)

Parameters​

docFile​

DocFile

The docFile to use as data source

templateName​

string

The document template name (Dokumentenvorlage)

additionalData?​

object

Optional data

Returns​

TemplateCompiler

Static​

Memberof​

TemplateCompiler

fromDocumentTemplate()​

static fromDocumentTemplate(fileTypeName, templateName, data?): TemplateCompiler

Creates a new instance of TemplateCompiler by a given filetype name and templateName (Dokumentenvorlage)

Parameters​

fileTypeName​

string

The Filetype name

templateName​

string

The document template name (Dokumentenvorlage)

data?​

object

Optional data

Returns​

TemplateCompiler

Static​

Memberof​

TemplateCompiler

fromFilePath()​

static fromFilePath(filePath, data): TemplateCompiler

Creates a new instance of TemplateCompiler by a template to load from filesystem

Parameters​

filePath​

string

The full path to the template

data​

object

Optional data

Returns​

TemplateCompiler

Static​

Memberof​

TemplateCompiler

compileFromDocFile()​

static compileFromDocFile(docFile, templateOrFilePath, additionalData?): string

Returns a compiled template by given data from docFile

Parameters​

docFile​

DocFile

The docFile to use as data source

templateOrFilePath​

string

The template as string to compile.

additionalData?​

object

Optional data

Returns​

string

Static​

Memberof​

TemplateCompiler

compileFromFilePath()​

static compileFromFilePath(filePath, data): string

Returns a compiled template by a template to load from filesystem

Parameters​

filePath​

string

The full path to the template

data​

object

Optional data

Returns​

string

Static​

Memberof​

TemplateCompiler

compileFromFileCoverTemplate()​

static compileFromFileCoverTemplate(docFile, fileCoverOptions?): string

Returns a compiled file cover template by given data from docFile

Parameters​

docFile​

DocFile

The docFile to use as data source

fileCoverOptions?​

FileCoverTemplateOptions

Optional file cover options

Returns​

string