@metamask/snaps-sdk
Version:
A library containing the core functionality for building MetaMask Snaps
29 lines • 833 B
text/typescript
import type { EnumToUnion } from "../../internals/index.mjs";
/**
* The encoding to use when retrieving the file. Defaults to `Base64`.
*/
export declare enum AuxiliaryFileEncoding {
Base64 = "base64",
Hex = "hex",
Utf8 = "utf8"
}
/**
* An object containing the parameters for the `snap_getFile` method.
*/
export type GetFileParams = {
/**
* The path to the file, relative to the Snap's package directory
* (that is, one level above `src`).
*/
path: string;
/**
* The encoding to use when retrieving the file. Defaults to `base64`.
*/
encoding?: EnumToUnion<AuxiliaryFileEncoding>;
};
/**
* The file content as a string in the requested encoding, or `null` if the
* file does not exist.
*/
export type GetFileResult = string | null;
//# sourceMappingURL=get-file.d.mts.map