Skip to content

Add details about file objects for React Native #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Acconut merged 3 commits into from
Oct 2, 2024
Merged

Add details about file objects for React Native #727

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21136d0
react native file argument details in api.md
h3knix Sep 26, 2024
b6bc82d
Update api.md
Acconut Oct 2, 2024
dd81cb9
Merge branch 'main' into patch-1
Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,7 @@ Depending on the platform, the `file` argument must be an instance of the follow
- inside browser: `File`, `Blob`, or [`Reader`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader)
- inside Node.js: `Buffer` or `Readable` stream
- inside Cordova: `File` object from a `FileEntry` (see [demo](/demos/cordova/www/js/index.js))
- inside React Native: Object with uri property: `{ uri: 'file:///...', ... }` (see [installation notes](/docs/installation.md#react-native-support) and [demo](/demos/reactnative/App.js))

The `options` argument will be merged deeply with `tus.defaultOptions`. See its documentation for more details.

Expand Down