@types/babel__generator
- Version 7.6.8
- Published
- 11.4 kB
- 1 dependency
- MIT license
Install
npm i @types/babel__generator
yarn add @types/babel__generator
pnpm add @types/babel__generator
Overview
TypeScript definitions for @babel/generator
Index
Functions
Classes
Interfaces
Functions
function generate
generate: ( ast: t.Node, opts?: GeneratorOptions, code?: string | { [filename: string]: string }) => GeneratorResult;
Turns an AST into code, maintaining sourcemaps, user preferences, and valid output.
Parameter ast
the abstract syntax tree from which to generate output code.
Parameter opts
used for specifying options for code generation.
Parameter code
the original source code, used for source maps.
Returns
- an object containing the output code and source map.
Classes
class CodeGenerator
class CodeGenerator {}
constructor
constructor(ast: t.Node, opts?: GeneratorOptions, code?: string);
method generate
generate: () => GeneratorResult;
Interfaces
interface GeneratorOptions
interface GeneratorOptions {}
property auxiliaryCommentAfter
auxiliaryCommentAfter?: string | undefined;
Optional string to add as a block comment at the end of the output file.
property auxiliaryCommentBefore
auxiliaryCommentBefore?: string | undefined;
Optional string to add as a block comment at the start of the output file.
property comments
comments?: boolean | undefined;
Should comments be included in output? Defaults to
true
.
property compact
compact?: boolean | 'auto' | undefined;
Set to true to avoid adding whitespace for formatting. Defaults to the value of
opts.minified
.
property concise
concise?: boolean | undefined;
Set to true to reduce whitespace (but not as much as opts.compact). Defaults to
false
.
property decoratorsBeforeExport
decoratorsBeforeExport?: boolean | undefined;
Set to true to enable support for experimental decorators syntax before module exports. Defaults to
false
.
property filename
filename?: string | undefined;
Used in warning messages
property importAttributesKeyword
importAttributesKeyword?: 'with' | 'assert' | 'with-legacy';
The import attributes/assertions syntax to use. When not specified, @babel/generator will try to match the style in the input code based on the AST shape.
property jsescOption
jsescOption?: | { /** * The default value for the quotes option is 'single'. This means that any occurrences of ' in the input * string are escaped as \', so that the output can be used in a string literal wrapped in single quotes. */ quotes?: 'single' | 'double' | 'backtick' | undefined;
/** * The default value for the numbers option is 'decimal'. This means that any numeric values are represented * using decimal integer literals. Other valid options are binary, octal, and hexadecimal, which result in * binary integer literals, octal integer literals, and hexadecimal integer literals, respectively. */ numbers?: 'binary' | 'octal' | 'decimal' | 'hexadecimal' | undefined;
/** * The wrap option takes a boolean value (true or false), and defaults to false (disabled). When enabled, the * output is a valid JavaScript string literal wrapped in quotes. The type of quotes can be specified through * the quotes setting. */ wrap?: boolean | undefined;
/** * The es6 option takes a boolean value (true or false), and defaults to false (disabled). When enabled, any * astral Unicode symbols in the input are escaped using ECMAScript 6 Unicode code point escape sequences * instead of using separate escape sequences for each surrogate half. If backwards compatibility with ES5 * environments is a concern, don’t enable this setting. If the json setting is enabled, the value for the es6 * setting is ignored (as if it was false). */ es6?: boolean | undefined;
/** * The escapeEverything option takes a boolean value (true or false), and defaults to false (disabled). When * enabled, all the symbols in the output are escaped — even printable ASCII symbols. */ escapeEverything?: boolean | undefined;
/** * The minimal option takes a boolean value (true or false), and defaults to false (disabled). When enabled, * only a limited set of symbols in the output are escaped: \0, \b, \t, \n, \f, \r, \\, \u2028, \u2029. */ minimal?: boolean | undefined;
/** * The isScriptContext option takes a boolean value (true or false), and defaults to false (disabled). When * enabled, occurrences of </script and </style in the output are escaped as <\/script and <\/style, and <!-- * is escaped as \x3C!-- (or \u003C!-- when the json option is enabled). This setting is useful when jsesc’s * output ends up as part of a <script> or <style> element in an HTML document. */ isScriptContext?: boolean | undefined;
/** * The compact option takes a boolean value (true or false), and defaults to true (enabled). When enabled, * the output for arrays and objects is as compact as possible; it’s not formatted nicely. */ compact?: boolean | undefined;
/** * The indent option takes a string value, and defaults to '\t'. When the compact setting is enabled (true), * the value of the indent option is used to format the output for arrays and objects. */ indent?: string | undefined;
/** * The indentLevel option takes a numeric value, and defaults to 0. It represents the current indentation level, * i.e. the number of times the value of the indent option is repeated. */ indentLevel?: number | undefined;
/** * The json option takes a boolean value (true or false), and defaults to false (disabled). When enabled, the * output is valid JSON. Hexadecimal character escape sequences and the \v or \0 escape sequences are not used. * Setting json: true implies quotes: 'double', wrap: true, es6: false, although these values can still be * overridden if needed — but in such cases, the output won’t be valid JSON anymore. */ json?: boolean | undefined;
/** * The lowercaseHex option takes a boolean value (true or false), and defaults to false (disabled). When enabled, * any alphabetical hexadecimal digits in escape sequences as well as any hexadecimal integer literals (see the * numbers option) in the output are in lowercase. */ lowercaseHex?: boolean | undefined; } | undefined;
Options for outputting jsesc representation.
property jsonCompatibleStrings
jsonCompatibleStrings?: boolean | undefined;
Set to true to run jsesc with "json": true to print "\u00A9" vs. "©";
property minified
minified?: boolean | undefined;
Should the output be minified. Defaults to
false
.
property retainFunctionParens
retainFunctionParens?: boolean | undefined;
Retain parens around function expressions (could be used to change engine parsing behavior) Defaults to
false
.
property retainLines
retainLines?: boolean | undefined;
Attempt to use the same line numbers in the output code as in the source code (helps preserve stack traces). Defaults to
false
.
property sourceFileName
sourceFileName?: string | undefined;
The filename for the source code (i.e. the code in the
code
argument). This will only be used ifcode
is a string.
property sourceMaps
sourceMaps?: boolean | undefined;
Enable generating source maps. Defaults to
false
.
property sourceRoot
sourceRoot?: string | undefined;
A root for all relative URLs in the source map.
method shouldPrintComment
shouldPrintComment: (comment: string) => boolean;
Function that takes a comment (as a string) and returns true if the comment should be included in the output. By default, comments are included if
opts.comments
istrue
or ifopts.minifed
isfalse
and the comment contains@preserve
or@license
.
interface GeneratorResult
interface GeneratorResult {}
Package Files (1)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/babel__generator
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/babel__generator)
- HTML<a href="https://www.jsdocs.io/package/@types/babel__generator"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3400 ms. - Missing or incorrect documentation? Open an issue for this package.