Method updateDescription

packages/widget-sdk/src/model/field.ts:264–287

* Updates the description for this field. * * Throws an error if the user does not have permission to update the field, or if an invalid description is provided. * * @param description new description for the field * @returns * * #### Example * ```js * field.updateDescr

(description: string | null)

   * ```
   */
  updateDescription(description: string | null): Promise<void> {
    const desc = description || undefined;
    if (description && description.length > MAX_DESC) {
      throw new Error('Description exceeds the maximum length limit of 200');
    }
    return new Promise(async(resolve) => {
      const result: ICollaCommandExecuteResult<any> = await cmdExecute({
        cmd: CollaCommandName.SetFieldAttr,
        datasheetId: this.datasheetId,
        fieldId: this.fieldData.id,
        data: {
          ...this.fieldData,
          desc
        }
      }, this.wCtx.id);
      if (result.result === ExecuteResult.Fail) {
        throw new Error(result.reason);
      }
      if (result.result === ExecuteResult.None) {
        throw new Error('update description method has been ignored');
      }
      resolve();
    });
  }

  /**
   *