docs: add file docs

docs/.vitepress/config.ts

@@ -8,6 +8,7 @@ import {
   collectionItems,
   mathItems,
   elementItems,
+  fileItems,
 } from './items'
 
 function withI18n(items: { link: string; text: string }[], locale: 'zh') {
@@ -72,6 +73,10 @@ export default defineConfig({
             text: '元素',
             items: withI18n(elementItems, 'zh'),
           },
+          {
+            text: '文件',
+            items: withI18n(fileItems, 'zh'),
+          },
         ],
 
         docFooter: {
@@ -130,6 +135,10 @@ export default defineConfig({
         text: 'Element',
         items: elementItems,
       },
+      {
+        text: 'File',
+        items: fileItems,
+      },
     ],
 
     socialLinks: [{ icon: 'github', link: 'https://github.com/varletjs/rattail' }],

docs/.vitepress/items/file.ts

@@ -0,0 +1,5 @@
+export const fileItems = [
+  { text: 'toDataURL', link: '/file/to-data-url' },
+  { text: 'toText', link: '/file/to-text' },
+  { text: 'toArrayBuffer', link: '/file/to-array-buffer' },
+]

docs/.vitepress/items/index.ts

@@ -6,3 +6,4 @@ export * from './collection'
 export * from './function'
 export * from './math'
 export * from './element'
+export * from './file'

docs/file/to-array-buffer.md

@@ -0,0 +1,26 @@
+# toArrayBuffer
+
+Converts a `File` object to an `ArrayBuffer`.
+
+### Usage
+
+```ts
+import { toArrayBuffer } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toArrayBuffer(file).then((arrayBuffer) => {
+  console.log(arrayBuffer)
+})
+```
+
+### Arguments
+
+| Arg    | Type   | Defaults |
+| ------ | ------ | -------- |
+| `file` | `File` |          |
+
+### Return
+
+| Type                   |
+| ---------------------- |
+| `Promise<ArrayBuffer>` |

docs/file/to-data-url.md

@@ -0,0 +1,26 @@
+# toDataURL
+
+Converts a `File` object to a Data URL string.
+
+### Usage
+
+```ts
+import { toDataURL } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toDataURL(file).then((dataUrl) => {
+  console.log(dataUrl)
+})
+```
+
+### Arguments
+
+| Arg    | Type   | Defaults |
+| ------ | ------ | -------- |
+| `file` | `File` |          |
+
+### Return
+
+| Type              |
+| ----------------- |
+| `Promise<string>` |

docs/file/to-text.md

@@ -0,0 +1,26 @@
+# toText
+
+Converts a `File` object to a text string.
+
+### Usage
+
+```ts
+import { toText } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toText(file).then((text) => {
+  console.log(text)
+})
+```
+
+### Arguments
+
+| Arg    | Type   | Defaults |
+| ------ | ------ | -------- |
+| `file` | `File` |          |
+
+### Return
+
+| Type              |
+| ----------------- |
+| `Promise<string>` |

docs/zh/file/to-array-buffer.md

@@ -0,0 +1,26 @@
+# toArrayBuffer
+
+将 `File` 对象转换为 `ArrayBuffer`。
+
+### 用法
+
+```ts
+import { toArrayBuffer } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toArrayBuffer(file).then((arrayBuffer) => {
+  console.log(arrayBuffer)
+})
+```
+
+### 参数
+
+| 参数   | 类型   | 默认值 |
+| ------ | ------ | ------ |
+| `file` | `File` |        |
+
+### 返回值
+
+| 类型                   |
+| ---------------------- |
+| `Promise<ArrayBuffer>` |

docs/zh/file/to-data-url.md

@@ -0,0 +1,26 @@
+# toDataURL
+
+将 `File` 对象转换为 Data URL 字符串。
+
+### 用法
+
+```ts
+import { toDataURL } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toDataURL(file).then((dataUrl) => {
+  console.log(dataUrl)
+})
+```
+
+### 参数
+
+| 参数   | 类型   | 默认值 |
+| ------ | ------ | ------ |
+| `file` | `File` |        |
+
+### 返回值
+
+| 类型              |
+| ----------------- |
+| `Promise<string>` |

docs/zh/file/to-text.md

@@ -0,0 +1,26 @@
+# toText
+
+将 `File` 对象转换为文本字符串。
+
+### 用法
+
+```ts
+import { toText } from 'rattail'
+
+const file = new File(['Hello, world!'], 'hello.txt', { type: 'text/plain' })
+toText(file).then((text) => {
+  console.log(text)
+})
+```
+
+### 参数
+
+| 参数   | 类型   | 默认值 |
+| ------ | ------ | ------ |
+| `file` | `File` |        |
+
+### 返回值
+
+| 类型              |
+| ----------------- |
+| `Promise<string>` |