SqlTemplateEngine | Node SQL Template Engine

SQL Template Engine

Hierarchy

SqlTemplateEngine

Index

Methods

Methods

invokeAbstractSyntaxTree

invokeAbstractSyntaxTree(abstractSyntaxTree: AbstractSyntaxTree, data: object): Promise<string[]>

- Defined in index.ts:58
Invoke an abstract syntax tree with a set of input data

throws

{RuntimeError} if there was unexpected statement, an expression error, an invalid template path or a data path reference error

throws

{RuntimeReadError} if there was an error reading a template file

throws

{RuntimeMaximumCallStackExceededError} if the maximum call depth is exceeded

Parameters
- abstractSyntaxTree: AbstractSyntaxTree
  
  The abstract syntax tree instance
- data: object
  
  The template input data
Returns Promise<string[]>

Resolves to an array of the output lines

invokeTemplateFile

invokeTemplateFile(file: string, data: object): Promise<string>

- Defined in index.ts:70
Invoke a template file with a set of input data

throws

{RuntimeError} if there was unexpected statement, an expression error, an invalid template path or a data path reference error

throws

{RuntimeReadError} if there was an error reading a template file

throws

{RuntimeMaximumCallStackExceededError} if the maximum call depth is exceeded

Parameters
- file: string
  
  The path to the template file
- data: object
  
  The template input data
Returns Promise<string>

Resolves to an array of the output lines

loadTemplateFile

loadTemplateFile(file: string): Promise<AbstractSyntaxTree>

- Defined in index.ts:79
Load a template file returning an abstract syntax tree

throws

{ParserError} if there are not enough tokens of the token does not match the passed types

throws

{FileLoadError} if the template file cannot be read

Parameters
- file: string
  
  The path to the template file
Returns Promise<AbstractSyntaxTree>

Resolves to an abstract syntax tree

Generated using TypeDoc