expo-file-system/build/File.types.d.ts

Provides access to the local file system on the device.

import type { File } from './File';
export type FileCreateOptions = {
    /**
     * Whether to create intermediate directories if they do not exist.
     * @default false
     */
    intermediates?: boolean;
    /**
     * Whether to overwrite the file if it exists.
     * @default false
     */
    overwrite?: boolean;
};
/**
 * Options for moving or copying files and directories.
 */
export type RelocationOptions = {
    /**
     * Whether to overwrite the destination if it exists.
     * @default false
     */
    overwrite?: boolean;
};
export declare enum EncodingType {
    /**
     * Standard encoding format.
     */
    UTF8 = "utf8",
    /**
     * Binary, radix-64 representation.
     */
    Base64 = "base64"
}
export type FileWriteOptions = {
    /**
     * The encoding format to use when writing the file.
     * @default FileSystem.EncodingType.UTF8
     */
    encoding?: EncodingType | 'utf8' | 'base64';
    /**
     * Whether to append the contents to the end of the file or overwrite the existing file.
     * @default false
     */
    append?: boolean;
};
/**
 * Specifies the access mode when opening a file handle.
 */
export declare enum FileMode {
    /**
     * Opens the file for both reading and writing.
     * The cursor is positioned at the beginning of the file.
     *
     * > **Note**: This mode cannot be used with SAF (Storage Access Framework) `content://` URIs.
     */
    ReadWrite = "rw",
    /**
     * Opens the file for reading only.
     * The cursor is positioned at the beginning of the file.
     */
    ReadOnly = "r",
    /**
     * Opens the file for writing only.
     * The cursor is positioned at the beginning of the file.
     */
    WriteOnly = "w",
    /**
     * Opens the file for writing only.
     * The cursor is positioned at the end of the file.
     *
     * > **Note**: For SAF files, this is a strict append-only mode.
     * The cursor cannot be moved; calling `seek()` will have no effect.
     */
    Append = "wa",
    /**
     * Opens the file for writing only and truncates the file to zero length (wipes content).
     */
    Truncate = "wt"
}
export declare class FileHandle {
    close(): void;
    readBytes(length: number): Uint8Array<ArrayBuffer>;
    writeBytes(bytes: Uint8Array): void;
    offset: number | null;
    size: number | null;
}
export type FileInfo = {
    /**
     * Indicates whether the file exists.
     */
    exists: boolean;
    /**
     * A URI pointing to the file. This is the same as the `fileUri` input parameter
     * and preserves its scheme (for example, `file://` or `content://`).
     */
    uri?: string;
    /**
     * The size of the file in bytes.
     */
    size?: number;
    /**
     * The last modification time of the file expressed in milliseconds since epoch.
     */
    modificationTime?: number;
    /**
     * A creation time of the file expressed in milliseconds since epoch. Returns null if the Android version is earlier than API 26.
     */
    creationTime?: number;
    /**
     * Present if the `md5` option was truthy. Contains the MD5 hash of the file.
     */
    md5?: string;
};
export type InfoOptions = {
    /**
     * Whether to return the MD5 hash of the file.
     *
     * @default false
     */
    md5?: boolean;
};
/**
 * Shared options accepted by file picker calls.
 */
export type PickFileGeneralOptions = {
    /**
     * A URI pointing to an initial folder in which the file picker is opened.
     */
    initialUri?: string;
    /**
     * The [MIME type(s)](https://en.wikipedia.org/wiki/Media_type) of the documents that are available
     * to be picked. It also supports wildcards like `'image/*'` to choose any image. To allow any type
     * of document you can use `'&ast;/*'`.
     * @default '&ast;/*'
     */
    mimeTypes?: string | string[];
    /**
     * Allows multiple files to be selected from the system UI.
     * @default false
     */
    multipleFiles?: boolean;
};
/**
 * Options for picking a single file.
 */
export type PickSingleFileOptions = PickFileGeneralOptions & {
    /**
     * Keeps the picker in single-file mode. Omit this property or set it to `false` when selecting one file.
     * @default false
     */
    multipleFiles?: false;
};
/**
 * Options for picking multiple files.
 */
export type PickMultipleFilesOptions = PickFileGeneralOptions & {
    /**
     * Allows multiple files to be selected from the system UI.
     */
    multipleFiles: true;
};
/**
 * Options type for file picking.
 * @hidden
 */
export type PickFileOptions = PickSingleFileOptions | PickMultipleFilesOptions;
/**
 * Result type for picking a single file.
 *
 * Successful picks return `{ result: File, canceled: false }`. Canceled picks return
 * `{ result: null, canceled: true }`.
 */
export type PickSingleFileResult = PickSingleFileSuccessResult | PickFileCanceledResult;
/**
 * Result type for picking multiple files.
 *
 * Successful picks return `{ result: File[], canceled: false }`. Canceled picks return
 * `{ result: null, canceled: true }`.
 */
export type PickMultipleFilesResult = PickMultipleFilesSuccessResult | PickFileCanceledResult;
/**
 * Result type for successfully picking a single file.
 * @inline
 * @docsInline
 */
export type PickSingleFileSuccessResult = {
    /**
     * The selected file.
     */
    result: File;
    /**
     * Indicates that the picker completed with a selected file.
     */
    canceled: false;
};
/**
 * Result type for successfully picking multiple files.
 * @inline
 * @docsInline
 */
export type PickMultipleFilesSuccessResult = {
    /**
     * The selected files.
     */
    result: File[];
    /**
     * Indicates that the picker completed with selected files.
     */
    canceled: false;
};
/**
 * Result type for a canceled file pick.
 * @inline
 * @docsInline
 */
export type PickFileCanceledResult = {
    /**
     * Always `null` when the picker is canceled.
     */
    result: null;
    /**
     * Indicates that the user canceled the picker without selecting files.
     */
    canceled: true;
};
//# sourceMappingURL=File.types.d.ts.map