From c933a66773670994ef4facbcdebdac00b797c35d Mon Sep 17 00:00:00 2001 From: git Date: Fri, 1 Sep 2017 00:41:10 +0900 Subject: [PATCH] Fix wrap --- docs/en/README.md | 158 +++++++++++++++++++++---------------------- docs/zh-cn/README.md | 157 +++++++++++++++++++++--------------------- 2 files changed, 158 insertions(+), 157 deletions(-) diff --git a/docs/en/README.md b/docs/en/README.md index 50f4726..6c750c9 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -152,7 +152,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `this.name` -* **Description:** +* **Description:** The `id` attribute of the input tag * **Usage:** @@ -171,7 +171,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `file` -* **Description:** +* **Description:** The `name` attribute of the input tag * **Usage:** @@ -190,7 +190,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** +* **Description:** `POST` Request upload URL * **Usage:** @@ -207,9 +207,9 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** - `PUT` Request upload URL - `put-action` is not empty Please give priority to` PUT` request +* **Description:** + `PUT` Request upload URL + `put-action` is not empty Please give priority to` PUT` request Required `html5` support * **Usage:** @@ -226,8 +226,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `{}` -* **Description:** - Attach `header` data +* **Description:** + Attach `header` data Required `html5` support * **Usage:** @@ -244,8 +244,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `{}` -* **Description:** - `POST request`: Append request `body` +* **Description:** + `POST request`: Append request `body` `PUT request`: Append request `query` * **Usage:** @@ -262,8 +262,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `[]` -* **Description:** - File List +* **Description:** + File List **In order to prevent unpredictable errors, can not directly modify the `files`, please use` add`, `update`,` remove` method to modify** * **[File object](#file)** @@ -283,9 +283,9 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** - The `accept` attribute of the input tag, MIME type - Required `html5` support +* **Description:** + The `accept` attribute of the input tag, MIME type + Required `html5` support * **Usage:** ```html @@ -302,9 +302,9 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` -* **Description:** - The `multiple` attribute of the input tag - Whether to allow multiple files to be selected +* **Description:** + The `multiple` attribute of the input tag + Whether to allow multiple files to be selected If it is `false` file inside only one file will be automatically deleted * **Usage:** @@ -319,10 +319,10 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` -* **Description:** - The `directory` attribute of the input tag - Whether it is a upload folder - [View supported browsers](http://caniuse.com/#feat=input-file-directory) +* **Description:** + The `directory` attribute of the input tag + Whether it is a upload folder + [View supported browsers](http://caniuse.com/#feat=input-file-directory) * **Usage:** ```html @@ -338,8 +338,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** - Allow upload file extensions +* **Description:** + Allow upload file extensions * **Usage:** ```html @@ -356,7 +356,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `0` -* **Description:** +* **Description:** Allow the maximum byte to upload * **Usage:** @@ -372,7 +372,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `0` -* **Description:** +* **Description:** Upload timeout time in milliseconds * **Usage:** @@ -388,8 +388,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `1` -* **Description:** - Also upload the number of files at the same time (number of threads) +* **Description:** + Also upload the number of files at the same time (number of threads) Required `html5` support * **Usage:** @@ -406,9 +406,9 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` -* **Description:** - Drag and drop upload - If set to `true`, read the parent component as a container +* **Description:** + Drag and drop upload + If set to `true`, read the parent component as a container Required `html5` support * **Usage:** @@ -425,8 +425,8 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `true` -* **Description:** - Whether to open the drag directory +* **Description:** + Whether to open the drag directory If set to `false` filter out the directory * **Usage:** @@ -445,8 +445,8 @@ const nodeExternals = require('webpack-node-externals'); * **Arguments:** * `files: Array` -* **Description:** - The files is changed to trigger the method +* **Description:** + The files is changed to trigger the method Default for `v-model` binding * **Usage:** @@ -477,10 +477,10 @@ const nodeExternals = require('webpack-node-externals'); * `oldFile: Object | undefined` `Read only` * `prevent: Function` -* **Description:** - Add, update, remove pre-filter - You can not use `update`,` add`, `remove`,` clear` methods in the event - The `newFile` object can be modified within the event +* **Description:** + Add, update, remove pre-filter + You can not use `update`,` add`, `remove`,` clear` methods in the event + The `newFile` object can be modified within the event `prevent()` can prevent modification * **Usage:** @@ -545,10 +545,10 @@ const nodeExternals = require('webpack-node-externals'); * `newFile: Object | undefined` `Read only` * `oldFile: Object | undefined` `Read only` -* **Description:** - Add, update, remove after - You can use `update`,` add`, `remove`,` clear` methods in the event - You can not modify the `newFile` object in the event +* **Description:** + Add, update, remove after + You can use `update`,` add`, `remove`,` clear` methods in the event + You can not modify the `newFile` object in the event You can not modify the `oldFile` object in the event * **Usage:** @@ -630,7 +630,7 @@ const nodeExternals = require('webpack-node-externals'); * **Result：** `Object | Boolean` There is a return file object that otherwise returns `false` -* **Description:** +* **Description:** Use `id` to get a file object @@ -641,7 +641,7 @@ const nodeExternals = require('webpack-node-externals'); * **Result：** `Object | Array | Boolean` The incoming array is returned to the array otherwise the object or `false` -* **Description:** +* **Description:** Add one or more files * **Usage:** @@ -681,7 +681,7 @@ const nodeExternals = require('webpack-node-externals'); * **Result：** `Object | Boolean` Successfully returned `newFile` failed to return` false` -* **Description:** +* **Description:** Update a file object * **Usage:** @@ -718,7 +718,7 @@ const nodeExternals = require('webpack-node-externals'); * **Result：** `Object | Boolean` Successfully returned `oldFile` failed to return` false` -* **Description:** +* **Description:** Remove a file object * **Usage:** @@ -750,7 +750,7 @@ const nodeExternals = require('webpack-node-externals'); ### clear * **Result：** `Boolean` Always return `true` -* **Description:** +* **Description:** Empty the file list @@ -766,7 +766,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `{html5: true, directory: false, drag: false}` -* **Description:** +* **Description:** Used to determine the browser support features @@ -789,7 +789,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` - * **Description:** + * **Description:** Activation or abort upload * **Usage:** @@ -810,7 +810,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` - * **Description:** + * **Description:** Is dragging * **Usage:** @@ -832,7 +832,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `true` - * **Description:** + * **Description:** All uploaded * **Usage:** @@ -865,7 +865,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `Math.random().toString(36).substr(2)` -* **Description:** +* **Description:** File ID @@ -878,7 +878,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `-1` -* **Description:** +* **Description:** File size Required `html5` support @@ -892,12 +892,12 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** ` ` -* **Description:** - Filename +* **Description:** + Filename - Format: - `directory/filename.gif` - `filename.gif` + Format: + `directory/filename.gif` + `filename.gif` @@ -908,12 +908,12 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `empty` -* **Description:** +* **Description:** MIME type - Format: - `image/gif` - `image/png` + Format: + `image/gif` + `image/png` `text/html` Required `html5` support @@ -927,11 +927,11 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` -* **Description:** +* **Description:** Activation or abort upload - `true` = Upload - `false` = Abort + `true` = Upload + `false` = Abort @@ -945,10 +945,10 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** ` ` -* **Description:** +* **Description:** Upload failed error code - Built-in + Built-in `size`, `extension`, `timeout`, `abort`, `network`, `server`, `denied` @@ -961,7 +961,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `false` -* **Description:** +* **Description:** Whether the upload was successful @@ -973,7 +973,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `this.putAction` -* **Description:** +* **Description:** Customize the current file `PUT` URL @@ -985,7 +985,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `this.postAction` -* **Description:** +* **Description:** Customize the current file `POST` URL @@ -999,7 +999,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `this.headers` -* **Description:** +* **Description:** Customize the current file `HTTP` Header @@ -1011,7 +1011,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `this.data` -* **Description:** +* **Description:** Customize the current file `body` or` query` to attach content @@ -1023,7 +1023,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `0` -* **Description:** +* **Description:** Customize the upload timeout for a current single file @@ -1036,7 +1036,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `{}` -* **Description:** +* **Description:** Response data @@ -1049,7 +1049,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `0.00` -* **Description:** +* **Description:** Upload progress @@ -1062,7 +1062,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `0` -* **Description:** +* **Description:** Per second upload speed @@ -1075,7 +1075,7 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** +* **Description:** `HTML5` upload` XMLHttpRequest` object @@ -1088,5 +1088,5 @@ const nodeExternals = require('webpack-node-externals'); * **Default:** `undefined` -* **Description:** +* **Description:** `HTML4` upload` iframe` element diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 6fdafa0..db5d443 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -150,7 +150,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `this.name` -* **描述：** +* **描述：** input标签的 `id` 属性 * **用法：** @@ -169,7 +169,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `file` -* **描述：** +* **描述：** input标签的 `name` 属性 * **用法：** @@ -188,7 +188,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** +* **描述：** `POST` 请求的上传URL * **用法：** @@ -205,10 +205,10 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** - `PUT` 请求的上传URL - `put-action` 不为空请优先 `PUT` 请求 - 需要`HTML5`支持 +* **描述：** + `PUT` 请求的上传URL + `put-action` 不为空请优先 `PUT` 请求 + 需要`HTML5`支持 * **用法：** ```html @@ -226,9 +226,9 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `{}` -* **描述：** - 自定义 `HTTP Header` - 需要`HTML5`支持 +* **描述：** + 自定义 `HTTP Header` + 需要`HTML5`支持 * **用法：** ```html @@ -244,9 +244,9 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `{}` -* **描述：** - `POST 请求`: 附加请求的 body - `PUT 请求`: 附加请求的 query +* **描述：** + `POST 请求`: 附加请求的 body + `PUT 请求`: 附加请求的 query * **用法：** ```html @@ -261,7 +261,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `[]` -* **描述：** +* **描述：** 文件列表 **为了防止不可预知的错误，不可直接修改 `files`，请使用 `add`, `update`, `remove` 方法修改** @@ -282,9 +282,9 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** - 表单的`accept`属性, MIME type - 需要`HTML5`支持 +* **描述：** + 表单的`accept`属性, MIME type + 需要`HTML5`支持 * **用法：** ```html @@ -300,10 +300,10 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` -* **描述：** - 文件表单的 `multiple` 属性 - 是否允许选择多个文件 - 如果是 `false` files 里面最多只有一个文件 多的会自动删除 +* **描述：** + 文件表单的 `multiple` 属性 + 是否允许选择多个文件 + 如果是 `false` `files` 里面最多只有一个文件 多的会自动删除 * **用法：** ```html @@ -317,10 +317,10 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` -* **描述：** - 文件表单的 `directory` 属性 - 是否是上传文件夹 - [查看支持的浏览器](http://caniuse.com/#feat=input-file-directory) +* **描述：** + 文件表单的 `directory` 属性 + 是否是上传文件夹 + [查看支持的浏览器](http://caniuse.com/#feat=input-file-directory) * **用法：** ```html @@ -336,7 +336,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** +* **描述：** 允许上传的文件后缀 * **用法：** @@ -354,7 +354,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `0` -* **描述：** +* **描述：** 允许上传的最大字节 * **用法：** @@ -370,7 +370,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `0` -* **描述：** +* **描述：** 上传超时时间毫秒 * **用法：** @@ -386,9 +386,9 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `1` -* **描述：** - 同时并发上传的文件数量 线程数 - 需要`HTML5`支持 +* **描述：** + 同时并发上传的文件数量 线程数 + 需要`HTML5`支持 * **用法：** ```html @@ -404,9 +404,9 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` -* **描述：** - 拖拽上传 - 如果设置成 `true` 则读取父组件作为容器 +* **描述：** + 拖拽上传 + 如果设置成 `true` 则读取父组件作为容器 需要`HTML5`支持 * **用法：** @@ -425,8 +425,8 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `true` -* **描述：** - 是否开启拖拽目录 +* **描述：** + 是否开启拖拽目录 如果设置成 `false` 则过滤掉目录 * **用法：** @@ -445,8 +445,8 @@ const nodeExternals = require('webpack-node-externals'); * **参数：** * `files: Array` -* **描述：** - 文件被改变触发的方法 +* **描述：** + 文件被改变触发的方法 默认用于`v-model`绑定 * **用法：** @@ -477,10 +477,11 @@ const nodeExternals = require('webpack-node-externals'); * `oldFile: Object | undefined` `只读` * `prevent: Function` -* **描述：** - 添加，更新，移除 前过滤器 - 事件内不可使用 `update`, `add`, `remove`, `clear` 方法 +* **描述：** + 添加，更新，移除 前过滤器 + 事件内不可使用 `update`, `add`, `remove`, `clear` 方法 事件内可修改 `newFile` 对象 + `prevent()` 用于阻止修改 * **用法：** ```html @@ -545,10 +546,10 @@ const nodeExternals = require('webpack-node-externals'); * `newFile: Object | undefined` `读写` * `oldFile: Object | undefined` `只读` -* **描述：** - 添加，更新，移除 后 - 事件内可使用 `update`, `add`, `remove`, `clear` 方法 - 事件内不可修改 `newFile` 对象 +* **描述：** + 添加，更新，移除 后 + 事件内可使用 `update`, `add`, `remove`, `clear` 方法 + 事件内不可修改 `newFile` 对象 事件内不可修改 `oldFile` 对象 * **用法：** @@ -630,7 +631,7 @@ const nodeExternals = require('webpack-node-externals'); * **返回值：** `Object | Boolean` 存在返回文件对象否则返回`false` -* **描述：** +* **描述：** 使用`id`获得某个文件对象 @@ -641,7 +642,7 @@ const nodeExternals = require('webpack-node-externals'); * **返回值：** `Object | Array | Boolean` 传入的是数组返回数组否则对象或`false` -* **描述：** +* **描述：** 添加一个或多个文件 * **用法：** @@ -681,7 +682,7 @@ const nodeExternals = require('webpack-node-externals'); * **返回值：** `Object | Boolean` 成功返回`newFile` 失败返回 `false` -* **描述：** +* **描述：** 更新某个文件对象 * **用法：** @@ -718,7 +719,7 @@ const nodeExternals = require('webpack-node-externals'); * **返回值：** `Object | Boolean` 成功返回 `oldFile` 失败返回 `false` -* **描述：** +* **描述：** 移除某个文件对象 * **用法：** @@ -766,7 +767,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `{html5: true, directory: false, drag: false}` -* **描述：** +* **描述：** 用于判断浏览器支持的特性 * **用法：** @@ -788,7 +789,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` - * **描述：** + * **描述：** 激活或停止上传 * **用法：** @@ -809,7 +810,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` - * **描述：** + * **描述：** 是否正在拖拽 * **用法：** @@ -832,7 +833,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `true` - * **描述：** + * **描述：** 是否全部已上传 * **用法：** @@ -864,7 +865,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `Math.random().toString(36).substr(2)` -* **描述：** +* **描述：** 文件id @@ -877,7 +878,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `-1` -* **描述：** +* **描述：** 文件大小 需要`HTML5`支持 @@ -891,11 +892,11 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `empty` -* **描述：** +* **描述：** 文件名 - 格式： - `directory/filename.gif` + 格式： + `directory/filename.gif` `filename.gif` @@ -907,13 +908,13 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** ` ` -* **描述：** +* **描述：** MIME类型 - 格式： - `image/gif` - `image/png` - `text/html` + 格式： + `image/gif` + `image/png` + `text/html` 需要`HTML5`支持 @@ -926,10 +927,10 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` -* **描述：** +* **描述：** 激活或终止上传 - `true` = 上传 + `true` = 上传 `false` = 停止 @@ -944,10 +945,10 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** ` ` -* **描述：** +* **描述：** 上传失败错误代码 - 内置 + 内置 `size`, `extension`, `timeout`, `abort`, `network`, `server`, `denied` @@ -960,7 +961,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `false` -* **描述：** +* **描述：** 是否上传成功 @@ -972,7 +973,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `this.putAction` -* **描述：** +* **描述：** 自定义当前文件 `PUT` 地址 @@ -984,7 +985,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `this.postAction` -* **描述：** +* **描述：** 自定义当前文件 `POST` 地址 @@ -998,7 +999,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `this.headers` -* **描述：** +* **描述：** 自定义当前文件 `HTTP` Header @@ -1010,7 +1011,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `this.data` -* **描述：** +* **描述：** 自定义当前文件 `body` 或 `query` 附加内容 @@ -1022,7 +1023,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `0` -* **描述：** +* **描述：** 自定义当前单个文件的上传超时时间 @@ -1035,7 +1036,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `{}` -* **描述：** +* **描述：** 响应的数据 @@ -1048,7 +1049,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `0.00` -* **描述：** +* **描述：** 上传进度 @@ -1061,7 +1062,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `0` -* **描述：** +* **描述：** 每秒的上传速度 @@ -1074,7 +1075,7 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** +* **描述：** `HTML5` 上传 `XMLHttpRequest` 对象 @@ -1087,5 +1088,5 @@ const nodeExternals = require('webpack-node-externals'); * **默认值：** `undefined` -* **描述：** +* **描述：** `HTML4` 上传 `iframe` 元素