json-fs-query 3.0.0 → 3.1.1
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 +3 -2
- package/browser/jsonFsQuery.js +12659 -13393
- package/browser/jsonFsQuery.min.js +1 -1
- package/dist/data/introspect/create.js +30 -1
- package/dist/data/introspect/create.min.js +1 -1
- package/dist/data/utilities/databaseLock.js +2 -1
- package/dist/data/utilities/databaseLock.min.js +1 -1
- package/dist/data/utilities/retrieveFile.js +2 -1
- package/dist/data/utilities/retrieveFile.min.js +1 -1
- package/package.json +8 -6
package/README.md
CHANGED
|
@@ -51,7 +51,8 @@ JSON can leave a key out or store it as `null`:
|
|
|
51
51
|
|
|
52
52
|
`useDefault: true, defaultValue: …` fills in a field that is left out. `create()` checks the default against the
|
|
53
53
|
field's type (a `null` default needs `nullable: true`) and throws if it doesn't fit. Primary key fields can't be
|
|
54
|
-
nullable.
|
|
54
|
+
nullable. Each key needs a non-empty `fields` list naming defined fields, and unknown key properties are rejected.
|
|
55
|
+
As in SQL, a `null` is never a duplicate in a unique key (any number of rows can hold it), and
|
|
55
56
|
a `null` foreign key isn't checked against the record it references.
|
|
56
57
|
|
|
57
58
|
## Writing queries
|
|
@@ -492,7 +493,7 @@ public API either way), but throw if actually called there, rather than being si
|
|
|
492
493
|
|
|
493
494
|
## Documentation
|
|
494
495
|
|
|
495
|
-
The reference for every function is in [`docs/`](https://joshuaheagle.com/projects/json-
|
|
496
|
+
The reference for every function is in [`docs/`](https://joshuaheagle.com/projects/json-fs-query/docs/index.html) (or open `docs/index.html` locally). It is generated from the TypeScript source, and each module is a folder of `src/data/`:
|
|
496
497
|
|
|
497
498
|
| Module | What it holds |
|
|
498
499
|
| --- | --- |
|