fix: update jsdoc comments for enums

This commit is contained in:
StevanFreeborn
2023-02-21 13:48:32 -06:00
committed by Stevan Freeborn
parent 2000a860a4
commit e97ee15387
4 changed files with 32 additions and 4 deletions
+16 -4
View File
@@ -1,4 +1,16 @@
export enum DelegateType {
External = 'External',
Internal = 'Internal',
}
/**
* @enum DelegateType - The type of delegate
*/
export enum DelegateType {
/**
* @constant External - The delegate is external.
* @type {string}
*/
External = 'External',
/**
* @constant Internal - The delegate is internal.
* @type {string}
*/
Internal = 'Internal',
}
+3
View File
@@ -1,3 +1,6 @@
/**
* @enum FileStorageSite - The site where the file is stored.
*/
export enum FileStorageSite {
/**
* @constant Internal - The file is stored in the internal file storage.
+10
View File
@@ -4,60 +4,70 @@
export enum FilterOperators {
/**
* @constant Equal - The equal operator
* @type {string}
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
*/
Equal = 'eq',
/**
* @constant NotEqual - The not equal operator
* @type {string}
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
*/
NotEqual = 'ne',
/**
* @constant Contains - The contains operator
* @type {string}
* @remarks Can be used with list fields as well as their formula equivalents.
*/
Contains = 'contains',
/**
* @constant IsNull - The is null operator
* @type {string}
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
*/
IsNull = 'isnull',
/**
* @constant NotNull - The not null operator
* @type {string}
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
*/
NotNull = 'notnull',
/**
* @constant GreaterThan - The greater than operator
* @type {string}
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
*/
GreaterThan = 'gt',
/**
* @constant LessThan - The less than operator
* @type {string}
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
*/
LessThan = 'lt',
/**
* @constant And - The and operator
* @type {string}
* @remarks Can be used to create compound filters.
*/
And = 'and',
/**
* @constant Or - The or operator
* @type {string}
* @remarks Can be used to create compound filters.
*/
Or = 'or',
/**
* @constant Not - The not operator
* @type {string}
* @remarks Can be used to negate a filter and create compound filters.
*/
Not = 'not',
+3
View File
@@ -1,3 +1,6 @@
/**
* @enum FormulaOutputType - The type of the formula output.
*/
export enum FormulaOutputType {
/**
* @constant Text - The formula output is a text value.