@orkestrel/table 0.0.3 → 0.0.5
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 +13 -15
- package/dist/src/core/index.cjs +286 -199
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +364 -429
- package/dist/src/core/index.d.ts +364 -429
- package/dist/src/core/index.js +284 -194
- package/dist/src/core/index.js.map +1 -1
- package/package.json +17 -14
package/README.md
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# @orkestrel/table
|
|
2
2
|
|
|
3
|
-
The environment-agnostic tabular document
|
|
4
|
-
the rows
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
decides to trust it.
|
|
11
|
-
|
|
3
|
+
> The environment-agnostic tabular document: a `TableSchema` declaring the columns, a `Table`
|
|
4
|
+
> holding the rows given against it, and one lens of sort, filter, and page deciding which of them
|
|
5
|
+
> the view shows.
|
|
6
|
+
|
|
7
|
+
Open a table with the `createTable` function, seed or add its rows through `table.rows`, and read
|
|
8
|
+
`table.view` for the rows to draw. Every row carries its own identity in a column the schema names,
|
|
9
|
+
so a pick survives a re-sort, and budgets bound what one schema may retain, so a document that
|
|
10
|
+
arrives from a wire costs a known maximum before anything decides to trust it. Built on
|
|
11
|
+
`@orkestrel/contract` and `@orkestrel/emitter`, and part of the `@orkestrel` line.
|
|
12
12
|
|
|
13
13
|
## Install
|
|
14
14
|
|
|
@@ -23,8 +23,6 @@ npm install @orkestrel/table
|
|
|
23
23
|
|
|
24
24
|
## Usage
|
|
25
25
|
|
|
26
|
-
Declare the columns, hold the rows, and read the ones to draw:
|
|
27
|
-
|
|
28
26
|
```ts
|
|
29
27
|
import { createTable } from '@orkestrel/table'
|
|
30
28
|
|
|
@@ -70,11 +68,11 @@ table.selection.keys.has('1') // true — a key, so it survives the next sort
|
|
|
70
68
|
|
|
71
69
|
## Guide
|
|
72
70
|
|
|
73
|
-
See [guides/table.md](./guides/table.md) for the documented surface — the
|
|
71
|
+
See [guides/table.md](./guides/table.md) for the documented surface — the column cells and what
|
|
74
72
|
each one fixes, the required identity column and the refusals built on it, the lens of sort, filter,
|
|
75
|
-
and page and the order it applies in, the
|
|
76
|
-
|
|
77
|
-
|
|
73
|
+
and page and the order it applies in, the events and when each one stays silent, the serialize/parse
|
|
74
|
+
wire boundary and what never crosses it, the budgets that bound a schema, and the concept inventory
|
|
75
|
+
of what this package leaves to the layer above.
|
|
78
76
|
|
|
79
77
|
## Package
|
|
80
78
|
|