From 21136d09061e21c1292b29b51a245b5dabfb78f9 Mon Sep 17 00:00:00 2001 From: Michael Vandenberghe Date: Thu, 26 Sep 2024 14:41:45 -0600 Subject: [PATCH 1/2] react native file argument details in api.md similar to the other platform explanations, react native specific implementation notes with links added --- docs/api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api.md b/docs/api.md index 5d28a921..4eda35f6 100644 --- a/docs/api.md +++ b/docs/api.md @@ -436,6 +436,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. From b6bc82db10fb9578699f2aba71785b24f52571a6 Mon Sep 17 00:00:00 2001 From: Marius Date: Wed, 2 Oct 2024 15:35:06 +0200 Subject: [PATCH 2/2] Update api.md --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 4eda35f6..68b05d5f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -436,7 +436,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) ) +- 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.