spreadsheet
typeScript/javascript spreadsheet parser, with formulas.
git clone https://git.vogt.world/spreadsheet.git
Log | Files | README.md
← All files
name: dist/Formulas/Info.d.ts
-rw-r--r--
5446
  1/**
  2 * Returns the "value not available" error, "#N/A".
  3 * @constructor
  4 */
  5declare let NA: () => never;
  6/**
  7 * Returns true if a value is text.
  8 * @param value - value or reference to check.
  9 * @returns {boolean}.
 10 * @constructor
 11 */
 12declare let ISTEXT: (value: any) => boolean;
 13/**
 14 * Returns true if a value is not text.
 15 * @param value - value or reference to check.
 16 * @returns {boolean}.
 17 * @constructor
 18 */
 19declare let ISNONTEXT: (value: any) => boolean;
 20/**
 21 * Returns true if value is a boolean (FALSE, or TRUE). Numerical and text values return false.
 22 * @param value - value or reference to check.
 23 * @returns {boolean}
 24 * @constructor
 25 */
 26declare let ISLOGICAL: (value: any) => boolean;
 27/**
 28 * Returns true if value or reference is a number.
 29 * @param value - value or reference to check.
 30 * @returns {boolean}
 31 * @constructor
 32 */
 33declare let ISNUMBER: (value: any) => boolean;
 34/**
 35 * Returns true if input is a valid email. Valid domains are Original top-level domains and Country code top-level
 36 * domains.
 37 * @param value - Value to check whether it is an email or not.
 38 * @returns {boolean}
 39 * @constructor
 40 */
 41declare let ISEMAIL: (value: any) => boolean;
 42/**
 43 * Returns true if the input is a valid URL.
 44 * @param value - Value to check
 45 * @returns {boolean}
 46 * @constructor
 47 */
 48declare let ISURL: (value: any) => boolean;
 49/**
 50 * Returns the value as a number.
 51 * @param value - value to return.
 52 * @returns {number}
 53 * @constructor
 54 */
 55declare let N: (value: any) => number;
 56/**
 57 * Tests if the content of one or several cells is a reference. Verifies the type of references in a cell or a range of
 58 * cells. If an error occurs, the function returns a logical or numerical value.
 59 * @param value - The value to be tested, to determine whether it is a reference.
 60 * @returns {boolean}
 61 * @constructor
 62 */
 63declare let ISREF: (value: any) => boolean;
 64/**
 65 * Returns the number corresponding to an error value occurring in a different cell. With the aid of this number, an
 66 * error message text can be generated. If an error occurs, the function returns a logical or numerical value.
 67 * @param value - Contains either the address/reference of the cell in which the error occurs, or the error directly.
 68 * Eg: `=ERRORTYPE(NA())`
 69 * @constructor
 70 */
 71declare let ERRORTYPE: (value: any) => 1 | 2 | 6 | 7 | 8 | 3 | 5 | 4;
 72/**
 73 * Returns TRUE if the reference to a cell is blank. This function is used to determine if the content of a cell is
 74 * empty. A cell with a formula inside is not empty. If an error occurs, the function returns a logical or numerical
 75 * value.
 76 * @param value - The content to be tested.
 77 * @returns {boolean}
 78 * @constructor
 79 */
 80declare let ISBLANK: (value: any) => boolean;
 81/**
 82 * Returns TRUE if the value refers to any error value except #N/A. You can use this function to control error values
 83 * in certain cells. If an error occurs, the function returns a logical or numerical value.
 84 * @param value - Any value or expression in which a test is performed to determine whether an error value not equal to
 85 * #N/A is present.
 86 * @returns {boolean}
 87 * @constructor
 88 */
 89declare let ISERR: (value: any) => boolean;
 90/**
 91 * Tests if the cells contain general error values. ISERROR recognizes the #N/A error value. If an error occurs, the
 92 * function returns a logical or numerical value.
 93 * @param value - is any value where a test is performed to determine whether it is an error value.
 94 * @returns {boolean}
 95 * @constructor
 96 */
 97declare let ISERROR: (value: any) => boolean;
 98/**
 99 * Returns TRUE if a cell contains the #N/A (value not available) error value. If an error occurs, the function returns
100 * a logical or numerical value.
101 * @param value - The value or expression to be tested.
102 * @returns {boolean}
103 * @constructor
104 */
105declare let ISNA: (value: any) => boolean;
106/**
107 * Returns the first argument if no error value is present, otherwise returns the second argument if provided, or a
108 * blank if the second argument is absent. Blank value is `null`.
109 * @param value - Value to check for error.
110 * @param valueIfError - [OPTIONAL] - Value to return if no error is present in the first argument.
111 * @returns {any}
112 * @constructor
113 */
114declare let IFERROR: (value: any, valueIfError?: any) => any;
115/**
116 * Returns a number corresponding to the type of data passed into the function. 1 = number, 2 = text, 4 = boolean,
117 * 16 = error, 64 = array/range, 128 = any other type of cell.
118 * @param value - Value for which the type will be determined.
119 * @returns {number}
120 * @constructor
121 */
122declare let TYPE: (value: any) => 1 | 2 | 16 | 4 | 64 | 128;
123/**
124 * Returns the column number of a specified cell, starting with column 1 for A.
125 * @param cell - Cell, defaults to the cell calling this formula, when used in the context of a spreadsheet.
126 * @constructor
127 */
128declare let COLUMN: (cell: any) => number;
129/**
130 * Returns the row number of a specified cell, starting with row 1 for A1.
131 * @param cell - Cell, defaults to the cell calling this formula, when used in the context of a spreadsheet.
132 * @constructor
133 */
134declare let ROW: (cell: any) => number;
135/**
136 * Returns TRUE if a cell is a formula cell. Must be given a reference.
137 * @param value - To check.
138 * @returns {boolean}
139 * @constructor
140 */
141declare let ISFORMULA: (value: any) => boolean;
142export { NA, ISTEXT, ISLOGICAL, ISNUMBER, ISNONTEXT, ISEMAIL, ISURL, N, ISREF, ERRORTYPE, ISBLANK, ISERR, ISERROR, ISNA, IFERROR, TYPE, COLUMN, ROW, ISFORMULA };