mn-docs-mcp 0.1.0

package/src/content/docs/reference/foundation/ns-file-handle.md

@@ -0,0 +1,445 @@
+---
+title: NSFileHandle
+description: 文件句柄（读写文件/标准输入输出）。
+---
+
+`NSFileHandle` 表示一个文件句柄，可用于读取/写入数据，或访问标准输入/输出/错误。
+
+## 类成员 (Class members)
+
+### `fileHandleWithStandardInput`
+
+标准输入句柄。
+
+```javascript
+static fileHandleWithStandardInput(): NSFileHandle
+```
+
+**Return Value:**
+
+- `NSFileHandle`: 标准输入句柄。
+
+### `fileHandleWithStandardOutput`
+
+标准输出句柄。
+
+```javascript
+static fileHandleWithStandardOutput(): NSFileHandle
+```
+
+**Return Value:**
+
+- `NSFileHandle`: 标准输出句柄。
+
+### `fileHandleWithStandardError`
+
+标准错误句柄。
+
+```javascript
+static fileHandleWithStandardError(): NSFileHandle
+```
+
+**Return Value:**
+
+- `NSFileHandle`: 标准错误句柄。
+
+### `fileHandleWithNullDevice`
+
+空设备句柄。
+
+```javascript
+static fileHandleWithNullDevice(): NSFileHandle
+```
+
+**Return Value:**
+
+- `NSFileHandle`: 空设备句柄。
+
+### `fileHandleForReadingAtPath`
+
+以只读方式打开文件。
+
+```javascript
+static fileHandleForReadingAtPath(path: string): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 文件路径。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+### `fileHandleForWritingAtPath`
+
+以只写方式打开文件。
+
+```javascript
+static fileHandleForWritingAtPath(path: string): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 文件路径。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+### `fileHandleForUpdatingAtPath`
+
+以读写方式打开文件。
+
+```javascript
+static fileHandleForUpdatingAtPath(path: string): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 文件路径。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+### `fileHandleForReadingFromURLError`
+
+从 URL 以只读方式打开。
+
+```javascript
+static fileHandleForReadingFromURLError(url: NSURL, error: any): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `url` | `NSURL` | 文件 URL。 |
+| `error` | `any` | 输出参数，接收错误。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+### `fileHandleForWritingToURLError`
+
+从 URL 以只写方式打开。
+
+```javascript
+static fileHandleForWritingToURLError(url: NSURL, error: any): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `url` | `NSURL` | 文件 URL。 |
+| `error` | `any` | 输出参数，接收错误。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+### `fileHandleForUpdatingURLError`
+
+从 URL 以读写方式打开。
+
+```javascript
+static fileHandleForUpdatingURLError(url: NSURL, error: any): NSFileHandle
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `url` | `NSURL` | 文件 URL。 |
+| `error` | `any` | 输出参数，接收错误。 |
+
+**Return Value:**
+
+- `NSFileHandle`: 句柄实例。
+
+## 实例成员 (Instance members)
+
+### `availableData`
+
+当前可读数据（非阻塞）。
+
+```javascript
+availableData(): NSData
+```
+
+**Return Value:**
+
+- `NSData`: 可读数据。
+
+### `readDataToEndOfFile`
+
+读取到文件末尾。
+
+```javascript
+readDataToEndOfFile(): NSData
+```
+
+**Return Value:**
+
+- `NSData`: 读取的数据。
+
+### `readDataOfLength`
+
+读取指定长度。
+
+```javascript
+readDataOfLength(length: number): NSData
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `length` | `number` | 字节数。 |
+
+**Return Value:**
+
+- `NSData`: 读取的数据。
+
+### `writeData`
+
+写入数据。
+
+```javascript
+writeData(data: NSData): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `data` | `NSData` | 要写入的数据。 |
+
+**Return Value:**
+
+- 无。
+
+### `offsetInFile`
+
+当前文件偏移。
+
+```javascript
+offsetInFile(): number
+```
+
+**Return Value:**
+
+- `number`: 偏移量（字节）。
+
+### `seekToEndOfFile`
+
+移动到文件末尾。
+
+```javascript
+seekToEndOfFile(): number
+```
+
+**Return Value:**
+
+- `number`: 新偏移量。
+
+### `seekToFileOffset`
+
+移动到指定偏移。
+
+```javascript
+seekToFileOffset(offset: number): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `offset` | `number` | 偏移量（字节）。 |
+
+**Return Value:**
+
+- 无。
+
+### `truncateFileAtOffset`
+
+在指定偏移处截断文件。
+
+```javascript
+truncateFileAtOffset(offset: number): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `offset` | `number` | 偏移量。 |
+
+**Return Value:**
+
+- 无。
+
+### `synchronizeFile`
+
+同步到磁盘。
+
+```javascript
+synchronizeFile(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `closeFile`
+
+关闭文件。
+
+```javascript
+closeFile(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `readInBackgroundAndNotify`
+
+在后台读取并发送通知（较少用）。
+
+```javascript
+readInBackgroundAndNotify(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `readInBackgroundAndNotifyForModes`
+
+在指定 run loop 模式下后台读取并通知。
+
+```javascript
+readInBackgroundAndNotifyForModes(modes: NSArray): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `modes` | `NSArray` | run loop 模式数组。 |
+
+**Return Value:**
+
+- 无。
+
+### `readToEndOfFileInBackgroundAndNotify`
+
+在后台读取到末尾并通知。
+
+```javascript
+readToEndOfFileInBackgroundAndNotify(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `readToEndOfFileInBackgroundAndNotifyForModes`
+
+在指定模式下后台读取到末尾并通知。
+
+```javascript
+readToEndOfFileInBackgroundAndNotifyForModes(modes: NSArray): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `modes` | `NSArray` | run loop 模式数组。 |
+
+**Return Value:**
+
+- 无。
+
+### `acceptConnectionInBackgroundAndNotify`
+
+在后台接受连接并通知（较少用）。
+
+```javascript
+acceptConnectionInBackgroundAndNotify(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `acceptConnectionInBackgroundAndNotifyForModes`
+
+在指定模式下后台接受连接并通知。
+
+```javascript
+acceptConnectionInBackgroundAndNotifyForModes(modes: NSArray): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `modes` | `NSArray` | run loop 模式数组。 |
+
+**Return Value:**
+
+- 无。
+
+### `waitForDataInBackgroundAndNotify`
+
+在后台等待数据并通知。
+
+```javascript
+waitForDataInBackgroundAndNotify(): void
+```
+
+**Return Value:**
+
+- 无。
+
+### `waitForDataInBackgroundAndNotifyForModes`
+
+在指定模式下后台等待数据并通知。
+
+```javascript
+waitForDataInBackgroundAndNotifyForModes(modes: NSArray): void
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `modes` | `NSArray` | run loop 模式数组。 |
+
+**Return Value:**
+
+- 无。
+
+### `fileDescriptor`
+
+底层文件描述符。
+
+```javascript
+fileDescriptor(): number
+```
+
+**Return Value:**
+
+- `number`: 文件描述符。

package/src/content/docs/reference/foundation/ns-file-manager.md

@@ -0,0 +1,275 @@
+---
+title: NSFileManager
+description: 文件系统操作，检查路径、创建目录、读写文件等。
+---
+
+用于文件系统操作。通过 `NSFileManager.defaultManager()` 获取默认实例。常与 [Application.documentPath](/reference/global/application/)、[Application.tempPath](/reference/global/application/) 配合使用。
+
+## 类成员 (Class members)
+
+### `defaultManager`
+
+获取默认文件管理器。
+
+```javascript
+static defaultManager(): NSFileManager
+```
+
+**Return Value:**
+
+- `NSFileManager`: 默认单例。
+
+## 实例成员 (Instance members)
+
+### 路径与目录
+
+### `fileExistsAtPath`
+
+检查文件或目录是否存在。
+
+```javascript
+fileExistsAtPath(path: string): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 文件或目录路径。 |
+
+### `isDirectoryAtPath`
+
+检查路径是否为目录。
+
+```javascript
+isDirectoryAtPath(path: string): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 路径。 |
+
+### `createDirectoryAtPathWithIntermediateDirectoriesAttributes`
+
+创建目录（支持创建中间目录）。
+
+```javascript
+createDirectoryAtPathWithIntermediateDirectoriesAttributes(path: string, withIntermediateDirectories: boolean, attributes: NSDictionary | null): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 目录路径。 |
+| `withIntermediateDirectories` | `boolean` | 是否创建中间目录。 |
+| `attributes` | `NSDictionary \| null` | 目录属性（通常传 null）。 |
+
+### `createDirectoryAtPathAttributes` (简易版)
+
+创建目录（简易版）。
+
+```javascript
+createDirectoryAtPathAttributes(path: string, attributes: NSDictionary | null): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 目录路径。 |
+| `attributes` | `NSDictionary \| null` | 目录属性。 |
+
+### `contentsOfDirectoryAtPath`
+
+获取目录内容（浅层遍历）。
+
+```javascript
+contentsOfDirectoryAtPath(path: string): string[]
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 目录路径。 |
+
+**Return Value:**
+
+- `string[]`: 文件名/子目录名列表。
+
+### `subpathsOfDirectoryAtPath`
+
+获取目录的所有子路径（深层遍历）。
+
+```javascript
+subpathsOfDirectoryAtPath(path: string): string[]
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 目录路径。 |
+
+### `subpathsAtPath`
+
+获取路径下的所有子路径。
+
+```javascript
+subpathsAtPath(path: string): string[]
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 路径。 |
+
+### `directoryContentsAtPath`
+
+获取目录内容（旧 API）。
+
+```javascript
+directoryContentsAtPath(path: string): string[]
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 目录路径。 |
+
+### 读写与复制
+
+### `contentsAtPath`
+
+读取文件内容。
+
+```javascript
+contentsAtPath(path: string): NSData
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 文件路径。 |
+
+**Return Value:**
+
+- `NSData`: 文件数据对象。
+
+### `copyItemAtPathToPath`
+
+复制文件或目录。
+
+```javascript
+copyItemAtPathToPath(srcPath: string, toPath: string): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `srcPath` | `string` | 源路径。 |
+| `toPath` | `string` | 目标路径。 |
+
+### `moveItemAtPathToPath`
+
+移动（重命名）文件或目录。
+
+```javascript
+moveItemAtPathToPath(srcPath: string, toPath: string): boolean
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `srcPath` | `string` | 源路径。 |
+| `toPath` | `string` | 目标路径。 |
+
+### 属性与权限
+
+### `attributesOfItemAtPath`
+
+获取文件/目录属性。
+
+```javascript
+attributesOfItemAtPath(path: string): NSDictionary
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 路径。 |
+
+### `attributesOfFileSystemForPath`
+
+获取文件系统属性（如磁盘空间）。
+
+```javascript
+attributesOfFileSystemForPath(path: string): NSDictionary
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 路径。 |
+
+### `fileAttributesAtPathTraverseLink`
+
+获取文件属性（遍历符号链接选项）。
+
+```javascript
+fileAttributesAtPathTraverseLink(path: string, traverseLink: boolean): NSDictionary
+```
+
+**Parameters:**
+
+| Name | Type | Description |
+| :--- | :--- | :--- |
+| `path` | `string` | 路径。 |
+| `traverseLink` | `boolean` | 是否跟随符号链接。 |
+
+### `isReadableFileAtPath`
+
+检查文件是否可读。
+
+```javascript
+isReadableFileAtPath(path: string): boolean
+```
+
+### `isWritableFileAtPath`
+
+检查文件是否可写。
+
+```javascript
+isWritableFileAtPath(path: string): boolean
+```
+
+### `isExecutableFileAtPath`
+
+检查文件是否可执行。
+
+```javascript
+isExecutableFileAtPath(path: string): boolean
+```
+
+### `isDeletableFileAtPath`
+
+检查文件是否可删除。
+
+```javascript
+isDeletableFileAtPath(path: string): boolean
+```
+
+## 相关
+
+- [NSData](/reference/foundation/ns-data/)、[Application](/reference/global/application/)
+- [教程：存储与文件](/guides/storage-and-files/)