@sketch-hq/sketch-file/dist/file.d.ts

Utilities to read and write Sketch documents

import FileFormat from '@sketch-hq/sketch-file-format-ts';
/**
 * Reads and parses Sketch documents.
 *
 * @param filepath - The file path to the Sketch document
 * @returns A {@link Promise} that resolves with a fully parsed {@link SketchFile} object once the file at the given path has been unzipped and read successfully
 */
declare const fromFile: (filepath: string) => Promise<SketchFile>;
/**
 * Saves a valid Sketch document.
 *
 * @param obj - The {@link SketchFile} object to be saved.
 * @returns A void Promise
 */
declare const toFile: (obj: SketchFile) => Promise<void>;
/**
 * Represents a Sketch file that is (or will be) on disk. Collates the
 * filepath with an object typed as Contents from the file format.
 */
declare type SketchFile = {
    filepath: string;
    contents: FileFormat.Contents;
};
export { fromFile, toFile, SketchFile };
//# sourceMappingURL=file.d.ts.map