expo-document-picker
Version:
Provides access to the system's UI for selecting documents from the available providers on the user's device.
15 lines • 1.01 kB
TypeScript
import { DocumentPickerOptions, DocumentPickerResult } from './types';
/**
* Display the system UI for choosing a document. By default, the chosen file is copied to [the app's internal cache directory](filesystem/#filesystemcachedirectory).
* > **Notes for Web:** The system UI can only be shown after user activation (e.g. a `Button` press).
* > Therefore, calling `getDocumentAsync` in `componentDidMount`, for example, will **not** work as
* > intended. The `cancel` event will not be returned in the browser due to platform restrictions and
* > inconsistencies across browsers.
*
* @return On success returns a promise that fulfils with [`DocumentPickerResult`](#documentpickerresult) object.
*
* If the user cancelled the document picking, the promise resolves to `{ type: 'cancel' }`.
*/
export declare function getDocumentAsync({ type, copyToCacheDirectory, multiple, base64, }?: DocumentPickerOptions): Promise<DocumentPickerResult>;
export * from './types';
//# sourceMappingURL=index.d.ts.map