expo-file-system

export declare class Directory { /** * Creates an instance of a directory. * @param uris - An array of: `file:///` string URIs, `File` instances, `Directory` instances representing an arbitrary location on the file system. The location does not need to exist, or it may already contain a file. * @example * ```ts * const directory = new Directory("file:///path/to/directory"); * ``` */ constructor(...uris: (string | File | Directory)[]); /** * Represents the directory URI. The field is read-only, but it may change as a result of calling some methods such as `move`. */ readonly uri: string; /** * Validates a directory path. * @hidden This method is not meant to be used directly. It is called by the JS constructor. */ validatePath(): void; /** * Deletes a directory. Also deletes all files and directories inside the directory. * * @throws Error if the directory does not exist or cannot be deleted. */ delete(): void; /** * A boolean representing if a directory exists. `true` if the directory exists, `false` otherwise. * Also `false` if the application does not have read access to the file. */ exists: boolean; /** * Creates a directory that the current uri points to. * * @throws Error if the containing folder doesn't exist, the application has no read access to it or the directory (or a file with the same path) already exists. */ create(): void; /** * Copies a directory. */ copy(destination: Directory | File): void; /** * Moves a directory. Updates the `uri` property that now points to the new location. */ move(destination: Directory | File): void; /** * @hidden * Lists the contents of a directory. Should not be used directly, as it returns a list of paths. * This function is internal and will be removed in the future (when returning arrays of shared objects is supported). */ listAsRecords(): { isDirectory: string; path: string }[]; /** * Lists the contents of a directory. */ list(): (Directory | File)[]; } /** * Represents a file on the file system. */ export declare class File { /** * Creates an instance of File. * * @param uri - A `file:///` URI representing an arbitrary location on the file system. The location does not need to exist, or it may already contain a directory. */ constructor(...uris: (string | File | Directory)[]); /** * Represents the file URI. The field is read-only, but it may change as a result of calling some methods such as `move`. */ readonly uri: string; /** * Validates a directory path. * @hidden This method is not meant to be used directly. It is called by the JS constructor. */ validatePath(): void; /** * Retrieves text from the file. * @returns The contents of the file as string. */ text(): string; /** * Retrieves content of the file as base64. * @returns The contents of the file as a base64 string. */ base64(): string; /** * Retrieves byte content of the entire file. * @returns The contents of the file as a Uint8Array. */ bytes(): Uint8Array; /** * Writes content to the file. * @param content - The content to write into the file. */ write(content: string | Uint8Array): void; /** * Deletes a file. * * @throws Error if the directory does not exist or cannot be deleted. */ delete(): void; /** * A boolean representing if a file exists. `true` if the file exists, `false` otherwise. * Also `false` if the application does not have read access to the file. */ exists: boolean; /** * Creates a file. * * @throws Error if the containing folder doesn't exist, the application has no read access to it or the file (or directory with the same path) already exists. */ create(): void; /** * Copies a file. */ copy(destination: Directory | File): void; /** * Moves a directory. Updates the `uri` property that now points to the new location. */ move(destination: Directory | File): void; /** * Returns a FileHandle object that can be used to read and write data to the file. * @throws Error if the file does not exist or cannot be opened. */ open(): FileHandle; /** * A static method that downloads a file from the network. * @param url - The URL of the file to download. * @param destination - The destination directory or file. If a directory is provided, the resulting filename will be determined based on the response headers. * @returns A promise that resolves to the downloaded file. * @example * ```ts * const file = await File.downloadFileAsync("https://example.com/image.png", new Directory(Paths.document)); * ``` */ static downloadFileAsync(url: string, destination: Directory | File): Promise<File>; /** * A size of the file in bytes. Null if the file does not exist or it cannot be read. */ size: number | null; /** * An md5 hash of the file. Null if the file does not exist or it cannot be read. */ md5: string | null; /** * A mime type of the file. Null if the file does not exist or it cannot be read. */ type: string | null; } export declare class FileHandle { /* * Closes the file handle. This allows the file to be deleted, moved or read by a different process. Subsequent calls to `readBytes` or `writeBytes` will throw an error. */ close(): void; /* * Reads the specified amount of bytes from the file at the current offset. * @param length - The number of bytes to read. */ readBytes(length: number): Uint8Array; /* * Writes the specified bytes to the file at the current offset. * @param bytes - A Uint8Array array containing bytes to write. */ writeBytes(bytes: Uint8Array): void; /* * A property that indicates the current byte offset in the file. Calling `readBytes` or `writeBytes` will read or write a specified amount of bytes starting from this offset. The offset is incremented by the number of bytes read or written. * The offset can be set to any value within the file size. If the offset is set to a value greater than the file size, the next write operation will append data to the end of the file. * Null if the file handle is closed. */ offset: number | null; /* * A size of the file in bytes or `null` if the file handle is closed. */ size: number | null; }