qvdjs 2.0.0 → 2.0.2

package/README.md

@@ -38,7 +38,7 @@ files, and validate output in your own Qlik environment** before relying on it.
 Qlik file and writing it back reproduces its symbol table byte for byte, whichever way it was read; a
 value you change is written as Qlik stores that kind of value. Where that boundary lies is the first
 thing worth reading:
-[What a round trip preserves](https://qvdjs.ptarmiganlabs.com/v1.0/overview/what-a-round-trip-preserves/).
+[What a round trip preserves](https://qvdjs.ptarmiganlabs.com/v2.0/overview/what-a-round-trip-preserves/).
 
 ## Checked against Qlik Sense
 
@@ -65,7 +65,7 @@ Two differences are by design: Qlik often gives a field more bits in the index t
 where qvdjs uses the fewest, and qvdjs adds no tags or number formats of its own - Qlik works tags out
 when it loads a file. QVD is also QlikView's format, but QlikView is not part of the comparison.
 
-→ [Checked against Qlik Sense](https://qvdjs.ptarmiganlabs.com/v1.0/overview/checked-against-qlik-sense/)
+→ [Checked against Qlik Sense](https://qvdjs.ptarmiganlabs.com/v2.0/overview/checked-against-qlik-sense/)
 
 ## Four ways to open a file
 
@@ -107,7 +107,7 @@ Reaching for `fromQvd` when you wanted one of the other three is the common mist
 `fromQvd(path, {maxRows: 0})` is **not** a substitute for `readMetadata`: it loads no rows but still
 parses the whole symbol table, which grows with the data.
 
-→ [Choosing an entry point](https://qvdjs.ptarmiganlabs.com/v1.0/getting-started/)
+→ [Choosing an entry point](https://qvdjs.ptarmiganlabs.com/v2.0/getting-started/)
 
 ## What a cell holds
 
@@ -171,7 +171,7 @@ NULL. A dual value - a `QvdDual`, or an object with exactly the keys `number` an
 as a dual, which is how a number gets the text Qlik displays. As in Qlik, a field holds one text per
 number, the first written. Anything else is refused with a `QvdValidationError`.
 
-→ [Writing a QVD](https://qvdjs.ptarmiganlabs.com/v1.0/guides/)
+→ [Writing a QVD](https://qvdjs.ptarmiganlabs.com/v2.0/guides/)
 
 ## Reading part of a file
 
@@ -211,7 +211,7 @@ try {
 When it is `iterate()` that overflowed, the context carries `recommendedChunkSize` as well, so a
 caller cannot mistake one recommendation for the other.
 
-→ [Memory and file size limits](https://qvdjs.ptarmiganlabs.com/v1.0/overview/memory-and-file-size-limits/)
+→ [Memory and file size limits](https://qvdjs.ptarmiganlabs.com/v2.0/overview/memory-and-file-size-limits/)
 
 ## Metadata
 
@@ -228,7 +228,7 @@ df.setFileMetadata({tableName: 'UpdatedProducts'});
 await df.toQvd('products-v2.qvd');
 ```
 
-→ [Metadata reference](https://qvdjs.ptarmiganlabs.com/v1.0/reference/)
+→ [Metadata reference](https://qvdjs.ptarmiganlabs.com/v2.0/reference/)
 
 ## File paths are sandboxed
 
@@ -252,7 +252,7 @@ is a different file at that name. Either is a `QvdSecurityError` whose `context.
 swapped for a symlink in the moment between the check and the open — is the one gap left, so keep
 the allowed directory's own subdirectories out of untrusted hands.
 
-→ [Path security](https://qvdjs.ptarmiganlabs.com/v1.0/overview/path-security/)
+→ [Path security](https://qvdjs.ptarmiganlabs.com/v2.0/overview/path-security/)
 
 ## Errors
 
@@ -273,7 +273,7 @@ without reporting an error; `error.context.filePosition` says where the file sto
 `error.name` is always the class name, in the CommonJS and ES module builds alike, so it works across
 a module boundary where `instanceof` may not.
 
-→ [Troubleshooting](https://qvdjs.ptarmiganlabs.com/v1.0/troubleshooting/)
+→ [Troubleshooting](https://qvdjs.ptarmiganlabs.com/v2.0/troubleshooting/)
 
 ## Known limitations
 
@@ -286,7 +286,7 @@ Honest boundaries rather than an issue list — these are the ones that change w
 | **A killed process can leave a temporary file**               | A write builds `<name>.qvdjs-<hex>.tmp` beside the QVD and removes it however the write ends — unless the process is killed outright, or the removal is itself refused, in which case the error names the file in `context.temporaryFile`. The QVD is untouched either way, and such a file can be deleted. `{atomic: false}` writes none when it rewrites a QVD that exists, and damages the QVD instead; a QVD that does not exist yet is renamed into place in either mode. |
 | **The writer takes numbers, strings, dual values and `null`** | Anything else - a `Date`, a boolean, an array, a `QvdSymbol` - is refused with a `QvdValidationError` naming the field and the row. Convert first: a `Date` to `new QvdDual(dateToQlikSerial(date), text)`, the serial and the text Qlik shows, which is how Qlik stores a date; a boolean to `-1` and `0`, as a Qlik comparison stores it.                                                                                                                                    |
 
-→ [What a round trip preserves](https://qvdjs.ptarmiganlabs.com/v1.0/overview/what-a-round-trip-preserves/)
+→ [What a round trip preserves](https://qvdjs.ptarmiganlabs.com/v2.0/overview/what-a-round-trip-preserves/)
 
 ## Documentation
 
@@ -295,13 +295,13 @@ where everything above is covered properly:
 
 |                                                                                                         |                                                                   |
 | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
-| [Getting started](https://qvdjs.ptarmiganlabs.com/v1.0/getting-started/)                                | Install, choose an entry point, first read and write              |
-| [Guides](https://qvdjs.ptarmiganlabs.com/v1.0/guides/)                                                  | One page per task, runnable sample code                           |
-| [Concepts](https://qvdjs.ptarmiganlabs.com/v1.0/concepts/)                                              | The QVD format, symbols and duals, bit stuffing, the memory model |
-| [Reference](https://qvdjs.ptarmiganlabs.com/v1.0/reference/)                                            | Every class, method, option and error                             |
-| [Performance](https://qvdjs.ptarmiganlabs.com/v1.0/performance/)                                        | Measured baselines, and how to read them                          |
-| [Troubleshooting](https://qvdjs.ptarmiganlabs.com/v1.0/troubleshooting/)                                | What each failure means, and what to do about it                  |
-| [Checked against Qlik Sense](https://qvdjs.ptarmiganlabs.com/v1.0/overview/checked-against-qlik-sense/) | How qvdjs's output is compared with Qlik Sense's                  |
+| [Getting started](https://qvdjs.ptarmiganlabs.com/v2.0/getting-started/)                                | Install, choose an entry point, first read and write              |
+| [Guides](https://qvdjs.ptarmiganlabs.com/v2.0/guides/)                                                  | One page per task, runnable sample code                           |
+| [Concepts](https://qvdjs.ptarmiganlabs.com/v2.0/concepts/)                                              | The QVD format, symbols and duals, bit stuffing, the memory model |
+| [Reference](https://qvdjs.ptarmiganlabs.com/v2.0/reference/)                                            | Every class, method, option and error                             |
+| [Performance](https://qvdjs.ptarmiganlabs.com/v2.0/performance/)                                        | Measured baselines, and how to read them                          |
+| [Troubleshooting](https://qvdjs.ptarmiganlabs.com/v2.0/troubleshooting/)                                | What each failure means, and what to do about it                  |
+| [Checked against Qlik Sense](https://qvdjs.ptarmiganlabs.com/v2.0/overview/checked-against-qlik-sense/) | How qvdjs's output is compared with Qlik Sense's                  |
 
 Benchmarks run weekly and publish to
 [ptarmiganlabs.github.io/qvdjs](https://ptarmiganlabs.github.io/qvdjs/).