@metamask/snaps-simulation/dist/files.d.mts

A simulation framework for MetaMask Snaps, enabling headless testing of Snaps in a controlled environment

import type { File } from "@metamask/snaps-sdk";
import { AuxiliaryFileEncoding } from "@metamask/snaps-sdk";
import type { VirtualFile } from "@metamask/snaps-utils";
import type { FileOptions } from "./types.mjs";
/**
 * Get a statically defined Snap file from an array of files.
 *
 * @param files - The Snap files.
 * @param path - The file path.
 * @param encoding - The requested file encoding.
 * @returns The file in the requested encoding if found, otherwise null.
 */
export declare function getSnapFile(files: VirtualFile[], path: string, encoding?: AuxiliaryFileEncoding): Promise<string | null>;
/**
 * Get the content type of a file based on its extension.
 *
 * @param extension - The file extension.
 * @returns The content type of the file. If the content type cannot be inferred
 * from the extension, `application/octet-stream` is returned.
 */
export declare function getContentType(extension: string): string;
/**
 * Get the size of a file, from a file path or a `Uint8Array`.
 *
 * @param file - The file to get the size of. This can be a path to a file or a
 * `Uint8Array` containing the file contents. If this is a path, the file is
 * resolved relative to the current working directory.
 * @returns The size of the file in bytes.
 */
export declare function getFileSize(file: string | Uint8Array): Promise<number>;
/**
 * Get a file object to upload, from a file path or a `Uint8Array`, with an
 * optional file name and content type.
 *
 * @param file - The file to upload. This can be a path to a file or a
 * `Uint8Array` containing the file contents. If this is a path, the file is
 * resolved relative to the current working directory.
 * @param options - The file options.
 * @param options.fileName - The name of the file. By default, this is
 * inferred from the file path if it's a path, and defaults to an empty string
 * if it's a `Uint8Array`.
 * @param options.contentType - The content type of the file. By default, this
 * is inferred from the file name if it's a path, and defaults to
 * `application/octet-stream` if it's a `Uint8Array` or the content type
 * cannot be inferred from the file name.
 * @returns The file object to upload.
 */
export declare function getFileToUpload(file: string | Uint8Array, { fileName, contentType }?: FileOptions): Promise<File>;
//# sourceMappingURL=files.d.mts.map