Class: FsStorage

mugshot.FsStorage

Write and read baselines to and from the local file system.

Screenshots will be saved with a .png extension.

Implements#

+ new FsStorage(resultsPath: string): FsStorage

Name	Type	Description
`resultsPath`	string	An absolute path or a path relative to cwd. The entire parent folder structure will be created if missing.

Returns: FsStorage

▸ delete(name: string): Promise<void>

Delete the screenshot for name.

If the screenshot doesn't exist, this should be a no-op.

Name	Type
`name`	string

Returns: Promise<void>

Implementation of: ScreenshotStorage.delete

▸ exists(name: string): Promise<boolean>

Check whether a screenshot exists for name.

Name	Type
`name`	string

Returns: Promise<boolean>

Implementation of: ScreenshotStorage.exists

▸ read(name: string): Promise<Buffer>

Return the screenshot for name as a PNG encoded buffer.

Name	Type
`name`	string

Returns: Promise<Buffer>

Implementation of: ScreenshotStorage.read

▸ write(name: string, data: Buffer): Promise<void>

Write a screenshot for name.

Name	Type
`name`	string
`data`	Buffer

Returns: Promise<void>

Implementation of: ScreenshotStorage.write