@argos-ci/util
Version:
Set of utilities used across all Argos SDKs.
43 lines (42 loc) • 1.53 kB
text/typescript
import { i as getMetadataPath, n as getScreenshotName, r as ScreenshotMetadata, t as validateThreshold } from "./threshold-BUYeKTxB.mjs";
//#region src/fs.d.ts
/**
* Create a directory if it doesn't exist.
*/
declare function createDirectory(pathname: string): Promise<void>;
/**
* Create temporary directory.
*/
declare function createTemporaryDirectory(): Promise<string>;
//#endregion
//#region src/git.d.ts
/**
* Get the top level of the git repository.
*/
declare function getGitRepositoryPath(): Promise<string | null>;
//#endregion
//#region src/introspection.d.ts
/**
* Read the version from a package.json file.
*/
declare function readVersionFromPackage(pkgPath: string): Promise<string>;
//#endregion
//#region src/metadata-io.d.ts
/**
* Write screenshot metadata to disk.
*/
declare function writeMetadata(screenshotPath: string, metadata: ScreenshotMetadata): Promise<void>;
/**
* Read screenshot metadata from disk.
* If not found, returns null.
*/
declare function readMetadata(screenshotPath: string): Promise<ScreenshotMetadata | null>;
//#endregion
//#region src/playwright-trace.d.ts
/**
* Get playwright trace from screenshot path.
* If not found, returns null.
*/
declare function getPlaywrightTracePath(screenshotPath: string): Promise<string | null>;
//#endregion
export { ScreenshotMetadata, createDirectory, createTemporaryDirectory, getGitRepositoryPath, getMetadataPath, getPlaywrightTracePath, getScreenshotName, readMetadata, readVersionFromPackage, validateThreshold, writeMetadata };