@builder.io/partytown/utils/index.d.ts

Relocate resource intensive third-party scripts off of the main thread and into a web worker.

/**
 * Utility to copy the Partytown library files to a destination on the server.
 * Partytown requires its library files, such as `partytown.js` to be served
 * as static files from the same origin. By default the library assumes all the
 * files can be found at `/~partytown/`, but this can be configured.
 *
 * This utility function is to make it easier to locate the source library files
 * and copy them to your server's correct location, for example: `./public/~partytown/`.
 *
 * By default, both the production and debug builds are copied to the destination.
 * However, by setting the `debugDir` option to `false`, the debug directory will
 * not be copied.
 *
 * https://partytown.builder.io/copy-library-files
 *
 * @public
 */
export declare function copyLibFiles(dest: string, opts?: CopyLibFilesOptions): Promise<{
    src: string;
    dest: string;
}>;

/**
 * @public
 */
export declare interface CopyLibFilesOptions {
    /**
     * When set to `false` the `lib/debug` directory will not be copied. The default is
     * that both the production and debug directories are copied to the destination.
     */
    debugDir?: boolean;
}

/**
 * @public
 */
export declare interface LibDirOptions {
    /**
     * When the `debugDir` option is set to `true`, the returned
     * directory is the absolute path to the `lib/debug` directory.
     */
    debugDir?: boolean;
}

/**
 * Absolute path to the Partytown lib directory within the
 * `@builder.io/partytown` package.
 *
 * https://partytown.builder.io/copy-library-files
 *
 * @public
 */
export declare function libDirPath(opts?: LibDirOptions): string;

/**
 * The Rollup plugin will copy Partytown `lib` directory to the given destination,
 * which must be an absolute file path.
 *
 * https://partytown.builder.io/copy-library-files
 *
 * @public
 */
export declare function partytownRollup(opts?: PartytownRollupOptions): {
    name: string;
};

/** @public */
export declare interface PartytownRollupOptions {
    /** An absolute path to the destination directory where the lib files should be copied. */
    dest?: string;
    /**
     * When `debug` is set to `false`, the `lib/debug` directory will not be copied.
     * The default is that both the production and debug directories are copied to the destination.
     */
    debug?: boolean;
}

/**
 * The Vite plugin will copy Partytown `lib` directory to the given destination,
 * which must be an absolute file path. When in dev mode, the Partytown
 * lib files will be served using the Vite Dev Server.
 *
 * https://partytown.builder.io/copy-library-files
 *
 * @public
 */
export declare function partytownVite(opts: PartytownViteOptions): {
    name: string;
};

/** @public */
export declare interface PartytownViteOptions extends PartytownRollupOptions {
}

export { }