declarations/babel-generator/babel-generator.d.ts

[](https://www.npmjs.com/package/declarations)

// Type definitions for babel-generator v6.7
// Project: https://github.com/babel/babel/tree/master/packages/babel-generator
// Definitions by: Troy Gerwien <https://github.com/yortus>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../babel-types/babel-types.d.ts" />

declare module "babel-generator" {
    import * as t from 'babel-types';
    type Node = t.Node;

    /**
     * Turns an AST into code, maintaining sourcemaps, user preferences, and valid output.
     * @param ast - the abstract syntax tree from which to generate output code.
     * @param opts - used for specifying options for code generation.
     * @param code - the original source code, used for source maps.
     * @returns - an object containing the output code and source map.
     */
    export default function generate(ast: Node, opts?: GeneratorOptions, code?: string | {[filename: string]: string}): GeneratorResult;

    export interface GeneratorOptions {

        /**
         * Optional string to add as a block comment at the start of the output file.
        */
        auxiliaryCommentBefore?: string;

        /**
         * Optional string to add as a block comment at the end of the output file.
        */
        auxiliaryCommentAfter?: string;

        /**
         * 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` is `true` or if `opts.minifed` is `false` and the comment
         * contains `@preserve` or `@license`.
         */
        shouldPrintComment?: (comment: string) => boolean;

        /**
         * Attempt to use the same line numbers in the output code as in the source code (helps preserve stack traces).
         * Defaults to `false`.
         */
        retainLines?: boolean;

        /**
         * Should comments be included in output? Defaults to `true`.
         */
        comments?: boolean;

        /**
         * Set to true to avoid adding whitespace for formatting. Defaults to the value of `opts.minified`.
         */
        compact?: boolean | 'auto';

        /**
         * Should the output be minified. Defaults to `false`.
         */
        minified?: boolean;

        /**
         * Set to true to reduce whitespace (but not as much as opts.compact). Defaults to `false`.
         */
        concise?: boolean;        

        /**
         * The type of quote to use in the output. If omitted, autodetects based on `ast.tokens`.
         */
        quotes?: 'single' | 'double';

        /**
         * Used in warning messages
         */
        filename?: string;        

        /**
         * Enable generating source maps. Defaults to `false`.
         */
        sourceMaps?: boolean;

        /**
         * The filename of the generated code that the source map will be associated with.
         */
        sourceMapTarget?: string;

        /**
         * A root for all relative URLs in the source map.
         */
        sourceRoot?: string;

        /**
         * The filename for the source code (i.e. the code in the `code` argument).
         * This will only be used if `code` is a string.
         */
        sourceFileName?: string;
    }

    export interface GeneratorResult {
        map: Object;
        code: string;
    }
}