@jsfkit/types 1.4.1 → 1.5.0
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.
- package/README.md +33 -2
- package/dist/index.d.ts +1917 -92
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,34 @@
|
|
|
1
|
-
|
|
1
|
+
JSF Types
|
|
2
|
+
=========
|
|
2
3
|
|
|
3
|
-
The JSON Spreadsheet Format (JSF) is a file format for representing spreadsheets in JSON. This
|
|
4
|
+
The JSON Spreadsheet Format (JSF) is a file format for representing spreadsheets in JSON. This
|
|
5
|
+
package contains the TypeScript types that describe the JSF format in full: workbooks, worksheets,
|
|
6
|
+
cells, drawings, and everything in between.
|
|
7
|
+
|
|
8
|
+
```sh
|
|
9
|
+
npm install @jsfkit/types
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
All types are exported from the package root:
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import type { Workbook, Worksheet, Cell } from '@jsfkit/types';
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
The two parts of JSF: workbooks and drawings
|
|
19
|
+
--------------------------------------------
|
|
20
|
+
|
|
21
|
+
JSF types are divided into two broad areas: workbooks and drawings. Workbooks chiefly covers the
|
|
22
|
+
data in a spreadsheet: the cells, values, formulas, their formatting. Drawings covers objects
|
|
23
|
+
that are drawn on top of the data: the shapes and images that sit on top of the cell grid.
|
|
24
|
+
|
|
25
|
+
Key workbook types:
|
|
26
|
+
|
|
27
|
+
- [`Workbook`](https://jsfkit.github.io/types/Workbook/)
|
|
28
|
+
- [`Worksheet`](https://jsfkit.github.io/types/Worksheet/)
|
|
29
|
+
- [`Cell`](https://jsfkit.github.io/types/Cell/)
|
|
30
|
+
|
|
31
|
+
Key drawing types:
|
|
32
|
+
|
|
33
|
+
- [`Graphic`](https://jsfkit.github.io/types/Graphic/)
|
|
34
|
+
- [`Shape`](https://jsfkit.github.io/types/Shape/)
|