aitable-workflow-cli 0.1.15 → 0.1.16-beta.1786022310508

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/CurrencyField /350/264/247/345/270/201/345/255/227/346/256/265.md"

@@ -1,260 +0,0 @@
-# CurrencyField 货币字段
-
-## 基本信息
-
-CurrencyField 类型专门处理货币值，支持不同货币类型（如人民币、美元、欧元等）和不同精度的小数位数。它提供了专门的货币格式化和显示功能，使货币数据在表格中更直观。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定记录在该货币字段的值。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<number | null>
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-
-**返回值**
-
-*   `Promise<number | null>`\- 货币值（数值），如果记录不存在或值为空则返回null
-    
-
-**示例**
-
-```typescript
-// 获取货币字段值
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  const price = await priceField.getValueAsync('rec123456');
-  if (price !== null) {
-    console.log(`价格: ${price}`);
-  } else {
-    console.log('未设置价格');
-  }
-}
-
-```
-```typescript
-// 获取货币字段值
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  const price = await priceField.getValueAsync('rec123456');
-  if (price !== null) {
-    Output.log(`价格: ${price}`);
-  } else {
-    Output.log('未设置价格');
-  }
-}
-
-```
-
-### setValueAsync
-
-设置指定记录在该货币字段的值。
-
-```typescript
-setValueAsync: (recordId: string, num: number | string) => Promise<boolean>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `num`: `number | string` - 要设置的货币值，可以是数字或可转换为数字的字符串
-    
-
-**返回值**
-
-*   `Promise<boolean>` - 操作是否成功
-    
-
-**示例**
-
-```typescript
-// 设置货币字段值
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  // 使用数字设置价格
-  const success1 = await priceField.setValueAsync('rec123456', 299.99);
-  
-  // 使用字符串设置价格
-  const success2 = await priceField.setValueAsync('rec234567', '599.50');
-  
-  console.log('价格设置成功');
-}
-
-```
-```typescript
-// 设置货币字段值
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  // 使用数字设置价格
-  const success1 = await priceField.setValueAsync('rec123456', 299.99);
-  
-  // 使用字符串设置价格
-  const success2 = await priceField.setValueAsync('rec234567', '599.50');
-  
-  Output.log('价格设置成功');
-}
-
-```
-
-### getDecimalDigits
-
-获取货币字段的小数位数。
-
-```typescript
-getDecimalDigits: () => number
-
-```
-
-**返回值**
-
-*   `number` - 小数位数，范围为0-4
-    
-
-**示例**
-
-```typescript
-// 获取货币字段的小数位数
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  const decimalDigits = priceField.getDecimalDigits();
-  console.log(`价格字段的小数位数: ${decimalDigits}`);
-}
-
-```
-```typescript
-// 获取货币字段的小数位数
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  const decimalDigits = priceField.getDecimalDigits();
-  console.log(`价格字段的小数位数: ${decimalDigits}`);
-}
-
-```
-
-### setDecimalDigits
-
-设置货币字段的小数位数。
-
-```typescript
-setDecimalDigits: (decimalDigits: number) => string
-
-```
-
-**参数**
-
-*   `decimalDigits`: `number` - 小数位数，必须是0-4之间的整数
-    
-
-**返回值**
-
-*   `string` - 字段ID
-    
-
-**示例**
-
-```typescript
-// 设置货币字段的小数位数
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  // 设置为2位小数
-  priceField.setDecimalDigits(2);
-  console.log('价格字段已设置为显示2位小数');
-}
-
-```
-```typescript
-// 设置货币字段的小数位数
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  // 设置为2位小数
-  priceField.setDecimalDigits(2);
-  Output.log('价格字段已设置为显示2位小数');
-}
-
-```
-
-### getCurrencyType
-
-获取货币字段的货币类型。
-
-```typescript
-getCurrencyType: () => CurrencyType
-
-```
-
-**返回值**
-
-*   [`CurrencyType`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_hHpVgVFkY3) - 货币类型，如'CNY'（人民币）、'USD'（美元）等
-    
-
-**示例**
-
-```typescript
-// 获取货币字段的货币类型
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  const currencyType = priceField.getCurrencyType();
-  console.log(`价格字段的货币类型: ${currencyType}`);
-}
-
-```
-```typescript
-// 获取货币字段的货币类型
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  const currencyType = priceField.getCurrencyType();
-  Output.log(`价格字段的货币类型: ${currencyType}`);
-}
-
-```
-
-### setCurrencyType
-
-设置货币字段的货币类型。
-
-```typescript
-setCurrencyType: (currencyType: CurrencyType) => string
-
-```
-
-**参数**
-
-*   `currencyType`: [`CurrencyType`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_hHpVgVFkY3) - 货币类型，必须是系统支持的货币类型之一
-    
-
-**返回值**
-
-*   `string` - 字段ID
-    
-
-**示例**
-
-```typescript
-// 设置货币字段的货币类型
-const priceField = sheet.getField<CurrencyField>('价格');
-if (priceField) {
-  // 设置为人民币
-  priceField.setCurrencyType('CNY');
-  console.log('价格字段已设置为人民币');
-}
-
-```
-```typescript
-// 设置货币字段的货币类型
-const priceField = sheet.getField('价格');
-if (Base.isFieldOfType(priceField, 'currency')) {
-  // 设置为人民币
-  priceField.setCurrencyType('CNY');
-  Output.log('价格字段已设置为人民币');
-}
-
-```

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/DateField /346/227/245/346/234/237/345/255/227/346/256/265.md"

@@ -1,183 +0,0 @@
-# DateField 日期字段
-
-DateField 继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理日期和时间类型数据。以毫秒级Unix时间戳形式存储。它支持不同的日期格式化选项，适合用于存储截止日期、创建时间、开始/结束时间等场景。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定记录在该日期字段的值。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<DateCellValue | null>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-
-**返回值**
-
-*   [`Promise<DateCellValue | null>`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_Xnx2DrcnwE) - 日期时间戳（毫秒），如果记录不存在或值为空则返回null
-    
-
-**示例**
-
-```typescript
-// 获取日期字段值
-const dueDateField = sheet.getField<DateField>('截止日期');
-if (dueDateField) {
-  const timestamp = await dueDateField.getValueAsync('rec123456');
-  if (timestamp !== null) {
-    const date = new Date(timestamp);
-    console.log(`截止日期: ${date.toLocaleDateString()}`);
-  } else {
-    console.log('未设置截止日期');
-  }
-}
-
-```
-```typescript
-// 获取日期字段值
-const dueDateField = sheet.getField('截止日期');
-if (Base.isFieldOfType(dueDateField, 'date')) {
-  const timestamp = await dueDateField.getValueAsync('rec123456');
-  if (timestamp !== null) {
-    const date = new Date(timestamp);
-    Output.log(`截止日期: ${date.toLocaleDateString()}`);
-  } else {
-    Output.log('未设置截止日期');
-  }
-}
-
-```
-
-### setValueAsync
-
-设置指定记录在该日期字段的值。
-
-```typescript
-setValueAsync: (recordId: string, timestamp: DateCellValue) => Promise<boolean>
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `timestamp`: [`DateCellValue`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_Xnx2DrcnwE) - 日期时间戳（毫秒）
-    
-
-**返回值**
-
-*   `Promise<boolean>`\- 操作是否成功
-    
-
-**示例**
-
-```typescript
-// 设置日期字段值
-const dueDateField = sheet.getField<DateField>('截止日期');
-if (dueDateField) {
-  // 设置为明天的日期
-  const tomorrow = new Date();
-  tomorrow.setDate(tomorrow.getDate() + 1);
-  
-  const success = await dueDateField.setValueAsync('rec123456', tomorrow.getTime());
-  if (success) {
-    console.log('截止日期已更新');
-  }
-}
-
-```
-```typescript
-// 设置日期字段值
-const dueDateField = sheet.getField('截止日期');
-if (Base.isFieldOfType(dueDateField, 'date')) {
-  // 设置为明天的日期
-  const tomorrow = new Date();
-  tomorrow.setDate(tomorrow.getDate() + 1);
-  
-  const success = await dueDateField.setValueAsync('rec123456', tomorrow.getTime());
-  if (success) {
-    Output.log('截止日期已更新');
-  }
-}
-
-```
-
-### getDateFormat
-
-获取日期字段的格式。
-
-```typescript
-getDateFormat: () => DateFormatter
-
-```
-
-**返回值**
-
-*   [`DateFormatter`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) - 日期格式化器对象
-    
-
-**示例**
-
-```typescript
-// 获取日期格式
-const createdTimeField = sheet.getField<DateField>('创建时间');
-if (createdTimeField) {
-  const formatter = createdTimeField.getDateFormat();
-  console.log(`日期格式: ${formatter}`);
-}
-
-```
-```typescript
-// 获取日期格式
-const createdTimeField = sheet.getField('创建时间');
-if (Base.isFieldOfType(createdTimeField, 'date')) {
-  const formatter = createdTimeField.getDateFormat();
-  Output.log(`日期格式: ${formatter}`);
-}
-
-```
-
-### setDateFormat
-
-设置日期字段的格式化器。
-
-```typescript
-setDateFormat: (formatter: DateFormatter) => string
-
-```
-
-**参数**
-
-*   `formatter`: [`DateFormatter`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) - 日期格式化器对象
-    
-
-**返回值**
-
-*   `string` - 字段ID
-    
-
-**示例**
-
-```typescript
-// 设置日期格式
-const dueDateField = sheet.getField<DateField>('截止日期');
-if (dueDateField) {
-  dueDateField.setDateFormat('YYYY/MM/DD HH:mm');
-  console.log('日期格式已更新');
-}
-
-```
-```typescript
-// 设置日期格式
-const dueDateField = sheet.getField('截止日期');
-if (Base.isFieldOfType(dueDateField, 'date')) {
-  dueDateField.setDateFormat('YYYY/MM/DD HH:mm');
-  Output.log('日期格式已更新');
-}
-
-```

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/DepartmentField /351/203/250/351/227/250/345/255/227/346/256/265.md"

@@ -1,111 +0,0 @@
-# DepartmentField 部门字段
-
-`DepartmentField` 继承自基础 [`Field`](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)类，专门用于处理部门类型数据。
-
-在读写群组字段前，请先了解钉钉部门deptId概念：
-
-:::
-**deptId**
-
-deptId用于唯一识别组织部门。
-
-[https://open.dingtalk.com/document/development/operations-related-to-address-book-departments: https://open.dingtalk.com/document/development/operations-related-to-address-book-departments](https://open.dingtalk.com/document/development/operations-related-to-address-book-departments)
-:::
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定记录在该部门字段中选择的部门。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<DepartmentCellValue[] | null>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-
-**返回值**
-
-*   [`Promise<DepartmentCellValue[] | null>`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=oX7l9bL61G&sheetId=hERWDMS&viewId=qvGDAH2)\- 选中的部门，返回部门名称和部门ID
-    
-
-**示例**
-
-```typescript
-// 获取记录的部门值
-const departmentField = sheet.getField<DepartmentField>('部门');
-if (departmentField) {
-  const departments = await departmentField.getValueAsync('rec123456');
-  console.log('查询到企业部门：', departments.map((dept) => (`部门名称：${dept.name}|部门ID: ${dept.openConversationId}`)).join('\n'));
-}
-```
-```typescript
-// 获取记录的部门值
-const departmentField = sheet.getField('部门');
-if (Base.isFieldOfType(departmentField, 'department')) {
-  const users = await departmentField.getValueAsync('rec123456');
-  Output.log('查询到企业部门：', departments.map((dept) => (`部门名称：${dept.name}|部门ID: ${dept.openConversationId}`)).join('\n'));
-}
-```
-
-### setValueAsync
-
-设置指定记录在该部门字段中的部门值。
-
-```typescript
-setValueAsync: (recordId: string, value: DepartmentCellValue[]) => Promise<boolean>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `value`: [`DepartmentCellValue[]`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=oX7l9bL61G&sheetId=hERWDMS&viewId=qvGDAH2) - 部门值，支持传入deptId
-    
-
-**返回值**
-
-*   `Promise<boolean>`\- 操作是否成功
-    
-
-**示例**
-
-```typescript
-// 设置记录的部门值
-const departmentField = sheet.getField<DeparmentField>('部门');
-if (departmentField) {
-  const success = await departmentField.setValueAsync('rec123456', [{
-    deptId: '1234',
-  }, {
-    deptId: '5678',
-  }]);
-  if (success) {
-    console.log('向记录中更新了两个部门');
-  } else {
-    console.log('记录更新失败');
-  }
-}
-
-```
-```typescript
-// 设置记录的部门值
-const departmentField = sheet.getField('部门');
-if (Base.isFieldOfType(departmentField, 'department')) {
-  const success = await departmentField.setValueAsync('rec123456', [{
-    deptId: '1234',
-  }, {
-    deptId: '5678',
-  }]);
-  if (success) {
-    Output.log('向记录中更新了两个部门');
-  } else {
-    Output.log('记录更新失败');
-  }
-}
-
-```

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/EmailField /351/202/256/347/256/261/345/255/227/346/256/265.md"

@@ -1,99 +0,0 @@
-# EmailField 邮箱字段
-
-`EmailField`，继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理邮箱字段数据。用于存储和验证邮箱地址信息。
-
-## 字段特有方法
-
-### getValueAsync
-
-获取指定行记录该邮箱字段的值。
-
-```typescript
-getValueAsync: (recordId: string) => Promise<string | null>
-
-```
-
-**参数**
-
-*   `recordId` : `string` - 记录ID
-    
-
-**返回值**
-
-*   `Promise<string | null>` - 邮箱地址值，当字段值为空时返回null
-    
-
-**示例**
-
-```typescript
-// 获取邮箱字段值
-const emailField = sheet.getField<EmailField>('联系邮箱');
-if (emailField) {
-  const email = await emailField.getValueAsync('rec123456');
-  console.log(`联系邮箱: ${email || '未填写'}`);
-}
-
-```
-```typescript
-// 获取邮箱字段值
-const emailField = sheet.getField('联系邮箱');
-if (Base.isFieldOfType(emailField, 'email')) {
-  const email = await emailField.getValueAsync('rec123456');
-  Output.log(`联系邮箱: ${email || '未填写'}`);
-}
-
-```
-
-### setValueAsync
-
-设置指定行记录该邮箱字段的值。
-
-```typescript
-setValueAsync: (recordId: string, text: string) => Promise<boolean>
-
-```
-
-**参数**
-
-*   `recordId`: `string` - 记录ID
-    
-*   `text`: `string` - 邮箱地址值
-    
-
-**返回值**
-
-*   `Promise<boolean>` - 设置是否成功
-    
-
-**重要提示**
-
-调用该API时，请确保邮箱地址为合法邮箱，否则更新数据将失败。
-
-**示例**
-
-```typescript
-// 设置邮箱字段值
-const emailField = sheet.getField<EmailField>('联系邮箱');
-if (emailField) {
-  const success = await emailField.setValueAsync('rec123456', 'example@company.com');
-  if (success) {
-    console.log('邮箱更新成功');
-  } else {
-    console.log('邮箱更新失败');
-  }
-}
-
-```
-```typescript
-// 设置邮箱字段值
-const emailField = sheet.getField('联系邮箱');
-if (Base.isFieldOfType(emailField, 'email')) {
-  const success = await emailField.setValueAsync('rec123456', 'example@company.com');
-  if (success) {
-    console.log('邮箱更新成功');
-  } else {
-    console.log('邮箱更新失败');
-  }
-}
-
-```