microcbor 1.0.0 → 1.1.0

package/README.md

@@ -166,14 +166,16 @@ export class CBOREncoderStream extends TransformStream<CBORValue, Uint8Array> {
 
 ```ts
 /** Decode a single CBOR value. */
-export function decode(data: Uint8Array): CBORValue
+export function decode<T extends CBORValue = CBORValue>(data: Uint8Array): T
 ```
 
 #### `decodeIterable`
 
 ```ts
 /** Decode an iterable of Uint8Array chunks into an iterable of CBOR values */
-export function* decodeIterable(source: Iterable<Uint8Array>): IterableIterator<CBORValue>
+export function* decodeIterable<T extends CBORValue = CBORValue>(
+  source: Iterable<Uint8Array>,
+): IterableIterator<T>
 
 ```
 
@@ -181,14 +183,16 @@ export function* decodeIterable(source: Iterable<Uint8Array>): IterableIterator<
 
 ```ts
 /** Decode an async iterable of Uint8Array chunks into an async iterable of CBOR values */
-export async function* decodeAsyncIterable(source: AsyncIterable<Uint8Array>): AsyncIterable<CBORValue>
+export async function* decodeAsyncIterable<T extends CBORValue = CBORValue>(
+  source: AsyncIterable<Uint8Array>,
+): AsyncIterable<CBORValue>
 ```
 
 #### `CBORDecoderStream`
 
 ```ts
 /** Decode a Web Streams API ReadableStream. */
-export class CBORDecoderStream extends TransformStream<Uint8Array, CBORValue> {
+export class CBORDecoderStream<T extends CBORValue = CBORValue> extends TransformStream<Uint8Array, T> {
   public constructor()
 }
 ```

package/lib/CBORDecoderStream.d.ts

@@ -1,5 +1,5 @@
 import { CBORValue } from "./types.js";
 /** Decode a Web Streams API ReadableStream */
-export declare class CBORDecoderStream extends TransformStream<Uint8Array, CBORValue> {
+export declare class CBORDecoderStream<T extends CBORValue = CBORValue> extends TransformStream<Uint8Array, T> {
     constructor();
 }

package/lib/Decoder.d.ts

@@ -18,4 +18,4 @@ export declare class Decoder {
     decodeValue(): CBORValue;
 }
 /** Decode a single CBOR value */
-export declare function decode(data: Uint8Array): CBORValue;
+export declare function decode<T extends CBORValue = CBORValue>(data: Uint8Array): T;

package/lib/decodeAsyncIterable.d.ts

@@ -1,5 +1,5 @@
 import type { CBORValue } from "./types.js";
-export declare class Decoder implements AsyncIterableIterator<CBORValue> {
+export declare class Decoder<T extends CBORValue = CBORValue> implements AsyncIterableIterator<T> {
     private offset;
     private byteLength;
     private readonly chunks;
@@ -29,7 +29,7 @@ export declare class Decoder implements AsyncIterableIterator<CBORValue> {
         value: undefined;
     } | {
         done: false;
-        value: CBORValue;
+        value: T;
     }>;
     private decodeValue;
 }

package/lib/decodeAsyncIterable.js

@@ -121,7 +121,7 @@ export class Decoder {
             }
         }
         const value = await this.decodeValue();
-        return { done: false, value };
+        return { done: false, value: value };
     }
     async decodeValue() {
         const initialByte = await this.uint8();

package/lib/decodeIterable.js

@@ -115,7 +115,7 @@ class Decoder {
             }
         }
         const value = this.decodeValue();
-        return { done: false, value };
+        return { done: false, value: value };
     }
     decodeValue() {
         const initialByte = this.uint8();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "microcbor",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"type": "module",
 	"files": [
 		"lib"