Stevan/onspring-api-sdk-javascript
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: add js doc comments.

Browse Source
This commit is contained in:
StevanFreeborn
2023-02-05 15:32:22 -06:00
parent e6eae35e03
commit fac2367052
5 changed files with 142 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/models/FormulaField.ts
+24
View File
@@ -2,10 +2,34 @@ import { FormulaOutputType } from '../enums/FormulaOutputType';
import { Field } from './Field';
import { type ListValue } from './ListValue';
/**
* @class FormulaField - Represents a formula field.
*/
export class FormulaField extends Field {
/**
* @property {FormulaOutputType} outputType - The output type of the formula.
*/
public outputType: FormulaOutputType;
/**
* @property {ListValue[]} values - The list values of the formula.
*/
public values: ListValue[];
/**
* @constructor - Creates a new FormulaField.
* @param {number} id - The id of the formula field.
* @param {number} appId - The id of the app the formula field belongs to.
* @param {string} name - The name of the formula field.
* @param {string} type - The type of the formula field.
* @param {string} status - The status of the formula field.
* @param {boolean} isRequired - Whether the formula field is required.
* @param {boolean} isUnique - Whether the formula field is unique.
* @param {string} outputType - The output type of the formula field.
* @param {ListValue[]} values - The list values of the formula field.
* @returns {FormulaField} - A new FormulaField.
* @throws {Error} - Throws an error if the outputType is not a valid FormulaOutputType.
*/
constructor(
id: number,
appId: number,