fix: update jsdoc comments for enums
This commit is contained in:
@@ -1,4 +1,16 @@
|
|||||||
export enum DelegateType {
|
/**
|
||||||
External = 'External',
|
* @enum DelegateType - The type of delegate
|
||||||
Internal = 'Internal',
|
*/
|
||||||
}
|
export enum DelegateType {
|
||||||
|
/**
|
||||||
|
* @constant External - The delegate is external.
|
||||||
|
* @type {string}
|
||||||
|
*/
|
||||||
|
External = 'External',
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @constant Internal - The delegate is internal.
|
||||||
|
* @type {string}
|
||||||
|
*/
|
||||||
|
Internal = 'Internal',
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @enum FileStorageSite - The site where the file is stored.
|
||||||
|
*/
|
||||||
export enum FileStorageSite {
|
export enum FileStorageSite {
|
||||||
/**
|
/**
|
||||||
* @constant Internal - The file is stored in the internal file storage.
|
* @constant Internal - The file is stored in the internal file storage.
|
||||||
|
|||||||
@@ -4,60 +4,70 @@
|
|||||||
export enum FilterOperators {
|
export enum FilterOperators {
|
||||||
/**
|
/**
|
||||||
* @constant Equal - The equal operator
|
* @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.
|
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
Equal = 'eq',
|
Equal = 'eq',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant NotEqual - The not equal operator
|
* @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.
|
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
NotEqual = 'ne',
|
NotEqual = 'ne',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant Contains - The contains operator
|
* @constant Contains - The contains operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used with list fields as well as their formula equivalents.
|
* @remarks Can be used with list fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
Contains = 'contains',
|
Contains = 'contains',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant IsNull - The is null operator
|
* @constant IsNull - The is null operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
|
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
IsNull = 'isnull',
|
IsNull = 'isnull',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant NotNull - The not null operator
|
* @constant NotNull - The not null operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
|
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
NotNull = 'notnull',
|
NotNull = 'notnull',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant GreaterThan - The greater than operator
|
* @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.
|
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
GreaterThan = 'gt',
|
GreaterThan = 'gt',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant LessThan - The less than operator
|
* @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.
|
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
|
||||||
*/
|
*/
|
||||||
LessThan = 'lt',
|
LessThan = 'lt',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant And - The and operator
|
* @constant And - The and operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used to create compound filters.
|
* @remarks Can be used to create compound filters.
|
||||||
*/
|
*/
|
||||||
And = 'and',
|
And = 'and',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant Or - The or operator
|
* @constant Or - The or operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used to create compound filters.
|
* @remarks Can be used to create compound filters.
|
||||||
*/
|
*/
|
||||||
Or = 'or',
|
Or = 'or',
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @constant Not - The not operator
|
* @constant Not - The not operator
|
||||||
|
* @type {string}
|
||||||
* @remarks Can be used to negate a filter and create compound filters.
|
* @remarks Can be used to negate a filter and create compound filters.
|
||||||
*/
|
*/
|
||||||
Not = 'not',
|
Not = 'not',
|
||||||
|
|||||||
@@ -1,3 +1,6 @@
|
|||||||
|
/**
|
||||||
|
* @enum FormulaOutputType - The type of the formula output.
|
||||||
|
*/
|
||||||
export enum FormulaOutputType {
|
export enum FormulaOutputType {
|
||||||
/**
|
/**
|
||||||
* @constant Text - The formula output is a text value.
|
* @constant Text - The formula output is a text value.
|
||||||
|
|||||||
Reference in New Issue
Block a user