@acoustic-content-sdk/tooling-data-overlay

Helper function to generate a data overlay.

API Documentation

Home > @acoustic-content-sdk/tooling-data-overlay

tooling-data-overlay package

Helper function to generate a data overlay

Functions

Function	Description
generateDataOverlay(aSrcDirOrPkg, aDstDir)	Overlays all transitively referenced packages and copies then into a target folder

Variables

Variable	Description
VERSION	Version and build number of the package

Home > @acoustic-content-sdk/tooling-data-overlay > generateDataOverlay

generateDataOverlay() function

Overlays all transitively referenced packages and copies then into a target folder

Signature:

export declare function generateDataOverlay(aSrcDirOrPkg: string, aDstDir: string): Promise<string[]>;

Parameters

Parameter	Type	Description
aSrcDirOrPkg	string	source directory or package name
aDstDir	string	target directory

Returns:

Promise<string[]>

the array of copied files

Home > @acoustic-content-sdk/tooling-data-overlay > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}