cbor-x 1.4.1 → 1.5.0

package/README.md

@@ -52,6 +52,26 @@ receivingStream.on('data', (data) => {
 ```
 The `EncoderStream` and `DecoderStream` instances  will have also the record structure extension enabled by default (see below).
 
+### Iterables
+In addition to using CBOR with streams, CBOR can also encode to an iterable that can be iterated as a sequence of binary chunks with `encodeAsIterable`, which facilitates progressive encoding:
+```JavaScript
+import { encodeAsIterable } from 'cbor-x';
+
+for (let binaryChunk of encodeAsIterable(data)){
+	// progressively get binary chunks as data is encoded
+}
+```
+And `encodeAsAsyncIterable` is also available, which returns an async iterable, and can be used to encode data from async iterables as well as Blob data.
+
+```JavaScript
+import { encodeAsAsyncIterable } from 'cbor-x';
+
+let data = { blob: new Blob(...) };
+for await (let binaryChunk of encodeAsAsyncIterable(data)){
+	// progressively get binary chunks as asynchronous data source is encoded
+}
+```
+
 ## Deno Usage
 Cbor-x modules are standard ESM modules and can be loaded directly from the [deno.land registry for cbor](https://deno.land/x/cbor) for use in Deno. The standard pack/encode and unpack/decode functionality is available on Deno, like other platforms.
 

package/decode.js

@@ -197,6 +197,7 @@ export function checkedRead() {
 			}
 			// bundled strings to skip past
 			position = bundledStrings.postBundlePosition;
+			bundledStrings = null;
 		}
 
 		if (position == srcEnd) {
@@ -933,18 +934,23 @@ currentExtensions[PACKED_REFERENCE_TAG_ID] = (data) => { // packed reference
 		return packedValues[16 + (data >= 0 ? 2 * data : (-2 * data - 1))]
 	throw new Error('No support for non-integer packed references yet')
 }
-currentExtensions[25] = (id) => {
-	return stringRefs[id]
-}
-currentExtensions[256] = (read) => {
-	stringRefs = []
-	try {
-		return read()
-	} finally {
-		stringRefs = null
-	}
-}
-currentExtensions[256].handlesRead = true
+
+// The following code is an incomplete implementation of http://cbor.schmorp.de/stringref
+// the real thing would need to implemennt more logic to populate the stringRefs table and
+// maintain a stack of stringRef "namespaces".
+//
+// currentExtensions[25] = (id) => {
+// 	return stringRefs[id]
+// }
+// currentExtensions[256] = (read) => {
+// 	stringRefs = []
+// 	try {
+// 		return read()
+// 	} finally {
+// 		stringRefs = null
+// 	}
+// }
+// currentExtensions[256].handlesRead = true
 
 currentExtensions[28] = (read) => { 
 	// shareable http://cbor.schmorp.de/value-sharing (for structured clones)