Renée Kooi 7 лет назад
Родитель
Сommit
587c4a1ea7
1 измененных файлов с 41 добавлено и 6 удалено
  1. 41 6
      website/src/docs/xhrupload.md

+ 41 - 6
website/src/docs/xhrupload.md

@@ -7,14 +7,49 @@ permalink: docs/xhrupload/
 
 
 The XHRUpload plugin handles classic HTML multipart form uploads, as well as uploads using the HTTP `PUT` method.
 The XHRUpload plugin handles classic HTML multipart form uploads, as well as uploads using the HTTP `PUT` method.
 
 
+```js
+uppy.use(XHRUpload, {
+  endpoint: 'http://my-website.org/upload'
+})
+```
+
 ## Options
 ## Options
 
 
+### `endpoint: ''`
+
+URL to upload to.
+
+### `method: 'post'`
+
+HTTP method to use for the upload.
+
+### `formData: true`
+
+Whether to use a multipart form upload, using [FormData][].
+When `true`, file metadata is also sent to the endpoint as separate form fields.
+When `false`, only the file contents are sent.
+
+### `fieldName: 'files[]'`
+
+When `formData` is true, this is used as the form field name for the file to be uploaded.
+
+### `metaFields: null`
+
+Pass an array of field names to limit the metadata fields that will be sent to the endpoint as form fields.
+For example, `metaFields: ['name']` will only send the `name` field.
+Passing `null` (the default) will send *all* metadata fields.
+
+If the `formData` option is false, `metaFields` has no effect.
+
+### `headers: {}`
+
+An object containing HTTP headers to use for the upload request.
+Keys are header names, values are header values.
+
 ```js
 ```js
-uppy.use(Tus10, {
-  resume: true,
-  allowPause: true,
-  autoRetry: true,
-  retryDelays: [0, 1000, 3000, 5000]
-})
+headers: {
+  'authorization': `Bearer ${window.getCurrentUserToken()}`
+}
 ```
 ```
 
 
+[FormData]: https://developer.mozilla.org/en-US/docs/Web/API/FormData