npm - aitable-workflow-cli - Versions diffs - 0.1.15 → 0.1.16-beta.1786022310508 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (263) hide show

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/BarcodeField /346/235/241/347/240/201/345/255/227/346/256/265.md" DELETED Viewed

@@ -1,95 +0,0 @@
-# BarcodeField 条码字段
-`BarcodeField`，继承自基础 [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 barcodeField = sheet.getField<BarcodeField>('商品条码');
-if (barcodeField) {
-  const barcode = await barcodeField.getValueAsync('rec123456');
-  console.log(`商品条码: ${barcode || '未填写'}`);
-}
-```
-```typescript
-// 获取条码字段值
-const barcodeField = sheet.getField('商品条码');
-if (Base.isFieldOfType(barcodeField, 'barcode')) {
-  const barcode = await barcodeField.getValueAsync('rec123456');
-  Output.log(`商品条码: ${barcode || '未填写'}`);
-}
-```
-### setValueAsync
-设置指定行记录该条码字段的值。
-```typescript
-setValueAsync: (recordId: string, text: string) => Promise<boolean>
-```
-**参数**
-*   `recordId`: `string` - 记录ID
-*   `text`: `string` - 条码值
-**返回值**
-*   `Promise<boolean>` - 设置是否成功
-**示例**
-```typescript
-// 设置条码字段值
-const barcodeField = sheet.getField<BarcodeField>('商品条码');
-if (barcodeField) {
-  const success = await barcodeField.setValueAsync('rec123456', '6901234567890');
-  if (success) {
-    console.log('条码更新成功');
-  } else {
-    console.log('条码更新失败');
-  }
-}
-```
-```typescript
-// 设置条码字段值
-const barcodeField = sheet.getField('商品条码');
-if (Base.isFieldOfType(barcodeField, 'barcode')) {
-  const success = await barcodeField.setValueAsync('rec123456', '6901234567890');
-  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/BidirectionalLinkField /345/217/214/345/220/221/345/205/263/350/201/224/345/255/227/346/256/265.md" DELETED Viewed

@@ -1,294 +0,0 @@
-# BidirectionalLinkField 双向关联字段
-BidirectionalLinkField 继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space)类，专门用于处理双向关联类型数据。用于在两个表之间建立双向关联关系，当在当前表中设置关联时，目标表中也会自动创建反向关联。
-## 字段特有方法
-### getValueAsync
-获取指定记录在该双向关联字段中的关联值。
-```typescript
-getValueAsync: (recordId: string) => Promise<AssociationsValue | null>
-```
-**参数**
-*   `recordId`: `string` - 记录ID
-**返回值**
-*   [`Promise<AssociationsValue | null>`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_ICnmHpkyc2) - 关联值对象，如果未设置关联则返回null
-**示例**
-```typescript
-// 获取记录的关联值
-const linkField = sheet.getField<BidirectionalLinkField>('关联项目');
-if (linkField) {
-  const linkValue = await linkField.getValueAsync('rec_123');
-  if (linkValue) {
-    console.log(`关联的记录数量: ${linkValue.linkedRecordIds.length}`);
-    // 打印每个关联的记录ID
-    linkValue.linkedRecordIds.forEach((recordId, index) => {
-      console.log(`关联记录${index + 1}: ${recordId}`);
-    });
-  } else {
-    console.log('该记录未设置任何关联');
-  }
-}
-```
-```typescript
-// 获取记录的关联值
-const linkField = sheet.getField('关联项目');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const linkValue = await linkField.getValueAsync('rec_123');
-  if (linkValue) {
-    Output.log(`关联的记录数量: ${linkValue.linkedRecordIds.length}`);
-    // 打印每个关联的记录ID
-    linkValue.linkedRecordIds.forEach((recordId, index) => {
-      Output.log(`关联记录${index + 1}: ${recordId}`);
-    });
-  } else {
-    Output.log('该记录未设置任何关联');
-  }
-}
-```
-### setValueAsync
-设置指定记录在该双向关联字段中的关联值。
-```typescript
-setValueAsync: (recordId: string, value: AssociationsValue) => Promise<boolean>
-```
-**参数**
-*   `recordId`: `string` - 记录ID
-*   `value`: [`AssociationsValue`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_ICnmHpkyc2) - 关联值对象
-**返回值**
-*   `Promise<boolean>` - 操作是否成功
-**示例**
-```typescript
-// 设置记录的关联值
-const linkField = sheet.getField<BidirectionalLinkField>('关联项目');
-if (linkField) {
-  const linkValue: AssociationsValue = {
-    linkedRecordIds: ['rec_project_1', 'rec_project_2']
-  };
-  const success = await linkField.setValueAsync('rec_123', linkValue);
-  if (success) {
-    console.log('关联设置成功');
-    console.log('注意：目标表中的相关记录也会自动建立反向关联');
-  } else {
-    console.log('关联设置失败');
-  }
-}
-```
-```typescript
-// 设置记录的关联值
-const linkField = sheet.getField('关联项目');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const linkValue: AssociationsValue = {
-    linkedRecordIds: ['rec_project_1', 'rec_project_2']
-  };
-  const success = await linkField.setValueAsync('rec_123', linkValue);
-  if (success) {
-    Output.log('关联设置成功');
-    Output.log('注意：目标表中的相关记录也会自动建立反向关联');
-  } else {
-    Output.log('关联设置失败');
-  }
-}
-```
-### setLinkedSheetId
-设置关联的目标数据表ID。
-```typescript
-setLinkedSheetId: (linkedSheetId: string) => string
-```
-**参数**
-*   `linkedSheetId`: `string` - 目标数据表ID
-**返回值**
-*   `string` - 字段ID
-**示例**
-```typescript
-// 设置关联的目标表
-const linkField = sheet.getField<BidirectionalLinkField>('关联项目');
-if (linkField) {
-  const fieldId = linkField.setLinkedSheetId('abcdefg');
-  console.log(`成功设置关联目标表，字段ID: ${fieldId}`);
-}
-```
-```typescript
-// 设置关联的目标表
-const linkField = sheet.getField('关联项目');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const fieldId = linkField.setLinkedSheetId('abcdefg');
-  Output.log(`成功设置关联目标表，字段ID: ${fieldId}`);
-}
-```
-### getLinkedSheetId
-获取当前关联的目标数据表ID。
-```typescript
-getLinkedSheetId: () => string
-```
-**返回值**
-*   `string` - 目标数据表ID
-**示例**
-```typescript
-// 获取关联的目标表ID
-const linkField = sheet.getField<BidirectionalLinkField>('关联项目');
-if (linkField) {
-  const linkedSheetId = linkField.getLinkedSheetId();
-  console.log(`关联的目标表ID: ${linkedSheetId}`);
-}
-```
-```typescript
-// 获取关联的目标表ID
-const linkField = sheet.getField('关联项目');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const linkedSheetId = linkField.getLinkedSheetId();
-  Output.log(`关联的目标表ID: ${linkedSheetId}`);
-}
-```
-### setMultiple
-设置是否允许关联多条记录。
-```typescript
-setMultiple: (multiple: boolean) => string
-```
-**参数**
-*   `multiple`: `boolean` - 是否允许多选，true表示可以关联多条记录，false表示只能关联一条记录
-**返回值**
-*   `string` - 字段ID
-**示例**
-```typescript
-// 设置允许关联多条记录
-const linkField = sheet.getField<BidirectionalLinkField>('关联任务');
-if (linkField) {
-  const fieldId = linkField.setMultiple(true);  // 允许关联多个任务
-  console.log(`已设置为允许多选，字段ID: ${fieldId}`);
-}
-// 设置只允许关联一条记录
-const ownerField = sheet.getField<BidirectionalLinkField>('负责人');
-if (ownerField) {
-  const fieldId = ownerField.setMultiple(false);  // 只能关联一个负责人
-  console.log(`已设置为单选模式，字段ID: ${fieldId}`);
-}
-```
-```typescript
-// 设置允许关联多条记录
-const linkField = sheet.getField<BidirectionalLinkField>('关联任务');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const fieldId = linkField.setMultiple(true);  // 允许关联多个任务
-  Output.log(`已设置为允许多选，字段ID: ${fieldId}`);
-}
-// 设置只允许关联一条记录
-const ownerField = sheet.getField<BidirectionalLinkField>('负责人');
-if (Base.isFieldOfType(ownerField, 'bidirectionalLink')) {
-  const fieldId = ownerField.setMultiple(false);  // 只能关联一个负责人
-  Output.log(`已设置为单选模式，字段ID: ${fieldId}`);
-}
-```
-### getMultiple
-获取当前是否允许关联多条记录的设置。
-```typescript
-getMultiple: () => boolean
-```
-**返回值**
-*   `boolean` - true表示允许多选，false表示只能单选
-**示例**
-```typescript
-// 检查多选设置
-const linkField = sheet.getField<BidirectionalLinkField>('关联项目');
-if (linkField) {
-  const isMultiple = linkField.getMultiple();
-  if (isMultiple) {
-    console.log('当前允许关联多条记录');
-  } else {
-    console.log('当前只允许关联一条记录');
-  }
-}
-```
-```typescript
-// 检查多选设置
-const linkField = sheet.getField('关联项目');
-if (Base.isFieldOfType(linkField, 'bidirectionalLink')) {
-  const isMultiple = linkField.getMultiple();
-  if (isMultiple) {
-    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/CheckboxField /345/244/215/351/200/211/346/241/206/345/255/227/346/256/265.md" DELETED Viewed

@@ -1,95 +0,0 @@
-# CheckboxField 复选框字段
-`CheckboxField`，继承自基础 [Field](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理开关类型的复选框字段数据。用于表示是/否、启用/禁用等二元状态。
-## 字段特有方法
-### getValueAsync
-获取指定行记录该复选框字段的值。
-```typescript
-getValueAsync: (recordId: string) => Promise<boolean | null>
-```
-**参数**
-*   `recordId` : `string` - 记录ID
-**返回值**
-*   `Promise<boolean | null>` - 复选框值(true/false)，当字段值为空时返回null
-**示例**
-```typescript
-// 获取复选框字段值
-const checkboxField = sheet.getField<CheckboxField>('已完成');
-if (checkboxField) {
-  const isChecked = await checkboxField.getValueAsync('rec123456');
-  console.log(`已完成状态: ${isChecked !== null ? (isChecked ? '是' : '否') : '未设置'}`);
-}
-```
-```typescript
-// 获取复选框字段值
-const checkboxField = sheet.getField('已完成');
-if (Base.isFieldOfType(checkboxField, 'checkbox')) {
-  const isChecked = await checkboxField.getValueAsync('rec123456');
-  Output.log(`已完成状态: ${isChecked !== null ? (isChecked ? '是' : '否') : '未设置'}`);
-}
-```
-### setValueAsync
-设置指定行记录该复选框字段的值。
-```typescript
-setValueAsync: (recordId: string, val: boolean) => Promise<boolean>
-```
-**参数**
-*   `recordId`: `string` - 记录ID
-*   `val`: `boolean` - 复选框值(true/false)
-**返回值**
-*   `Promise<boolean>` - 设置是否成功
-**示例**
-```typescript
-// 设置复选框字段值
-const checkboxField = sheet.getField<CheckboxField>('已完成');
-if (checkboxField) {
-  const success = await checkboxField.setValueAsync('rec123456', true);
-  if (success) {
-    console.log('复选框状态更新成功');
-  } else {
-    console.log('复选框状态更新失败');
-  }
-}
-```
-```typescript
-// 设置复选框字段值
-const checkboxField = sheet.getField('已完成');
-if (Base.isFieldOfType(checkboxField, 'checkbox')) {
-  const success = await checkboxField.setValueAsync('rec123456', true);
-  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/CreatedTimeField /345/210/233/345/273/272/346/227/266/351/227/264/345/255/227/346/256/265.md" DELETED Viewed

@@ -1,134 +0,0 @@
-# CreatedTimeField 创建时间字段
-`CreatedTimeField`，继承自基础 [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 createdTimeField = sheet.getField<CreatedTimeField>('创建时间');
-if (createdTimeField) {
-  const timestamp = await createdTimeField.getValueAsync('rec123456');
-  if (timestamp !== null) {
-    const date = new Date(timestamp);
-    console.log(`创建时间: ${date.toLocaleString()}`);
-  } else {
-    console.log('未设置创建时间');
-  }
-}
-```
-```typescript
-// 获取创建时间字段值
-const createdTimeField = sheet.getField('创建时间');
-if (Base.isFieldOfType(createdTimeField, 'createdTime')) {
-  const timestamp = await createdTimeField.getValueAsync('rec123456');
-  if (timestamp !== null) {
-    const date = new Date(timestamp);
-    Output.log(`创建时间: ${date.toLocaleString()}`);
-  } else {
-    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<CreatedTimeField>('创建时间');
-if (createdTimeField) {
-  const formatter = createdTimeField.getDateFormat();
-  console.log(`创建时间格式: ${formatter}`);
-}
-```
-```typescript
-// 获取创建时间字段格式
-const createdTimeField = sheet.getField('创建时间');
-if (Base.isFieldOfType(createdTimeField, 'createdTime')) {
-  const formatter = createdTimeField.getDateFormat();
-  Output.log(`创建时间格式: ${formatter}`);
-}
-```
-### setDateFormat
-设置创建时间字段的格式。
-```typescript
-setDateFormat: (format: DateFormatter) => string
-```
-**参数**
-*   `format`: [`DateFormatter`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) - 日期格式
-**返回值**
-*   `string` - 字段ID
-**示例**
-```typescript
-// 设置创建时间字段格式
-const createdTimeField = sheet.getField<CreatedTimeField>('创建时间');
-if (createdTimeField) {
-  createdTimeField.setDateFormat('YYYY-MM-DD HH:mm:ss');
-  console.log('创建时间格式已更新');
-}
-```
-```typescript
-// 设置创建时间字段格式
-const createdTimeField = sheet.getField('创建时间');
-if (Base.isFieldOfType(createdTimeField, 'createdTime')) {
-  createdTimeField.setDateFormat('YYYY-MM-DD HH:mm:ss');
-  Output.log('创建时间格式已更新');
-}
-```