Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TemplateBuilderOptions

Hierarchy

Index

Properties

Optional allowAwaitOutsideFunction

allowAwaitOutsideFunction: undefined | false | true

By default, await use is not allowed outside of an async function. Set this to true to accept such code.

Optional allowImportExportEverywhere

allowImportExportEverywhere: undefined | false | true

By default, import and export declarations can only appear at a program's top level. Setting this option to true allows them anywhere where a statement is allowed.

Optional allowReturnOutsideFunction

allowReturnOutsideFunction: undefined | false | true

By default, a return statement at the top level raises an error. Set this to true to accept such code.

Optional allowSuperOutsideMethod

allowSuperOutsideMethod: undefined | false | true

Optional allowUndeclaredExports

allowUndeclaredExports: undefined | false | true

By default, exported identifiers must refer to a declared variable. Set this to true to allow export statements to reference undeclared variables.

Optional createParenthesizedExpressions

createParenthesizedExpressions: undefined | false | true

By default, the parser adds information about parentheses by setting extra.parenthesized to true as needed. When this option is true the parser creates ParenthesizedExpression AST nodes instead of using the extra property.

Optional placeholderPattern

placeholderPattern: RegExp | false

A pattern to search for when looking for Identifier and StringLiteral nodes that should be considered placeholders. false will disable placeholder searching entirely, leaving only the placeholderWhitelist value to find placeholders.

Optional placeholderWhitelist

placeholderWhitelist: Set<string>

A set of placeholder names to automatically accept. Items in this list do not need to match the given placeholder pattern.

Optional plugins

plugins: ParserPlugin[]

Array containing the plugins that you want to enable.

Optional preserveComments

preserveComments: undefined | false | true

Set this to true to preserve any comments from the code parameter.

Optional ranges

ranges: undefined | false | true

Adds a ranges property to each node: [node.start, node.end]

Optional sourceFilename

sourceFilename: undefined | string

Correlate output AST nodes with their source filename. Useful when generating code and source maps from the ASTs of multiple input files.

Optional sourceType

sourceType: "script" | "module" | "unambiguous"

Indicate the mode the code should be parsed in. Can be one of "script", "module", or "unambiguous". Defaults to "script". "unambiguous" will make @babel/parser attempt to guess, based on the presence of ES6 import or export statements. Files with ES6 imports and exports are considered "module" and are otherwise "script".

Optional startLine

startLine: undefined | number

By default, the first line of code parsed is treated as line 1. You can provide a line number to alternatively start with. Useful for integration with other source tools.

Optional strictMode

strictMode: undefined | false | true

Should the parser work in strict mode. Defaults to true if sourceType === 'module'. Otherwise, false.

Optional tokens

tokens: undefined | false | true

Adds all parsed tokens to a tokens property on the File node.