@sheetxl/primitives 0.8.0-beta.10 → 0.8.0-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/browser/esm/index.mjs +1 -1
  2. package/node/esm/index.mjs +1 -1
  3. package/package.json +1 -1
  4. package/types/src/IRichData.d.ts +19 -2
package/browser/esm/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @license @sheetxl/primitives - Primitives - Base types for SheetXL functions. - v0.8.0-beta.10
2
+ * @license @sheetxl/primitives - Primitives - Base types for SheetXL functions. - v0.8.0-beta.11
3
3
  *
4
4
  * (C) 2026-present SheetXL Inc. & Michael T. Ford
5
5
  * License: The license can be found at https://www.sheetxl.com/license.
package/node/esm/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @license @sheetxl/primitives - Primitives - Base types for SheetXL functions. - v0.8.0-beta.10
2
+ * @license @sheetxl/primitives - Primitives - Base types for SheetXL functions. - v0.8.0-beta.11
3
3
  *
4
4
  * (C) 2026-present SheetXL Inc. & Michael T. Ford
5
5
  * License: The license can be found at https://www.sheetxl.com/license.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sheetxl/primitives",
3
3
  "description": "Primitives - Base types for SheetXL functions.",
4
- "version": "0.8.0-beta.10",
4
+ "version": "0.8.0-beta.11",
5
5
  "license": "SEE LICENSE IN <LICENSE>",
6
6
  "type": "module",
7
7
  "exports": {
package/types/src/IRichData.d.ts CHANGED
@@ -13,12 +13,29 @@ export interface IRichData {
13
13
  */
14
14
  getProperty(name: string): Scalar;
15
15
  /**
16
- * For clients that don't support IRichData.
16
+ * The text shown for this value where nothing renders it: a client with no renderer for the
17
+ * kind, a log, a placeholder. A rich text shows its text; an image a short description.
17
18
  *
18
19
  * @remarks
19
- * `toString()` can used when a Rich Data is not supported for example clipboard and sorting.
20
+ * Display only. What the value reads as to calculation, sorting and the clipboard is
21
+ * {@link toPrimitive}.
20
22
  */
21
23
  toString(): string;
24
+ /**
25
+ * The primitive this value reads as wherever one is consumed: `LEN`, `&`, `+`, comparison,
26
+ * `ISTEXT`, `TYPE()`, sort, filter, find. A rich text reads as its text; an image reads as
27
+ * nothing (`null`, or the method absent), and is `#VALUE!` wherever a primitive is needed.
28
+ *
29
+ * @remarks
30
+ * The ordinary rules then apply to the primitive (text-to-number coercion, collation), so a
31
+ * value adds no coercions of its own.
32
+ */
33
+ toPrimitive?(): number | string | boolean | null;
34
+ /**
35
+ * The items this value unpacks to where a range or array is accepted (a list); `null`, or the
36
+ * method absent, for a value that is one value.
37
+ */
38
+ toArray?(): Scalar[][] | null;
22
39
  /**
23
40
  * Indicates this is an IRichData type.
24
41
  */