ts-writer/dist/writer.d.ts

import ts from 'typescript';
import type { Commands, KeysOf, SourceTemplateData, TemplateHelper } from './types';
export declare class TsWriter<H extends readonly TemplateHelper[] | undefined = readonly TemplateHelper[] | undefined> {
    readonly helpers?: H | undefined;
    /**
     * A simple map of all the sources that have been written.
     *
     * The string array represents the result of each write call, **not each written line**.
     */
    readonly sources: Record<string, string[]>;
    private outputs;
    readonly host: ts.CompilerHost;
    readonly compilerOptions: ts.CompilerOptions;
    /**
     * Constructs a new TsWriter instance.
     *
     * @param optionsOrTsconfigPath Either the compiler options or the path to a tsconfig
     *   file.
     */
    constructor(optionsOrTsconfigPath: ts.CompilerOptions | string, helpers?: H | undefined);
    /**
     * Collects all the written files and uses typescript to transpile them.
     *
     * @returns The result of the transpilation from typescript.
     */
    transpile(): Record<string, string>;
    /**
     * Generates the code to be written in the provided file. The first argument is an
     * object with the variables to be used in the template, as well the filename. The rest
     * of the arguments are the templates to be written in the file.
     */
    write<D extends SourceTemplateData<H>, P extends KeysOf<Omit<D, 'helpers'>>[]>(template: TemplateStringsArray, data: D, ...keys: Commands<P[number], D & {
        helpers: H;
    }>[]): void;
    /**
     * Generates the code to be written **ON TOP** in the provided file. The first argument
     * is an object with the variables to be used in the template, as well the filename. The
     * rest of the arguments are the templates to be written in the file.
     */
    head<D extends SourceTemplateData<H>, P extends KeysOf<Omit<D, 'helpers'>>[]>(template: TemplateStringsArray, data: D, ...keys: Commands<P[number], D & {
        helpers: H;
    }>[]): void;
    /**
     * Generates the code to be written in the provided file **ONLY IF NOT ALREADY
     * WRITTEN**. The first argument is an object with the variables to be used in the
     * template, as well the filename. The rest of the arguments are the templates to be
     * written in the file.
     */
    writeUnique<D extends SourceTemplateData<H>, P extends KeysOf<Omit<D, 'helpers'>>[]>(template: TemplateStringsArray, data: D, ...keys: Commands<P[number], D & {
        helpers: H;
    }>[]): void;
    /**
     * Generates the code to be written **ON TOP** in the provided file **ONLY IF NOT
     * ALREADY WRITTEN**. The first argument is an object with the variables to be used in
     * the template, as well the filename. The rest of the arguments are the templates to be
     * written in the file.
     */
    headUnique<D extends SourceTemplateData<H>, P extends KeysOf<Omit<D, 'helpers'>>[]>(template: TemplateStringsArray, data: D, ...keys: Commands<P[number], D & {
        helpers: H;
    }>[]): void;
}
//# sourceMappingURL=writer.d.ts.map