feat: update encode methods to return Uint8Array<ArrayBuffer>

Author: nomadshiba

deno.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nomadshiba/codec",
-	"version": "0.5.0-preview.1",
+	"version": "0.5.0-preview.2",
 	"license": "LGPL-2.1-only",
 	"exports": "./lib/mod.ts",
 	"tasks": {

lib/bytes/bytes.ts

@@ -105,7 +105,7 @@ export class BytesCodec<const O extends BytesOptions | undefined = undefined> ex
 	 * codec.encode(new Uint8Array([1, 2]));        // throws RangeError
 	 * ```
 	 */
-	public encode(value: Uint8Array): Uint8Array {
+	public encode(value: Uint8Array): Uint8Array<ArrayBuffer> {
 		if (this.stride.kind === "fixed") {
 			if (value.length !== this.stride.size) {
 				throw new RangeError(

lib/bytes/string.ts

@@ -108,7 +108,7 @@ export class StringCodec<const O extends StringOptions | undefined = undefined>
 	 * codec.encode("hi");    // throws RangeError
 	 * ```
 	 */
-	public encode(value: string): Uint8Array {
+	public encode(value: string): Uint8Array<ArrayBuffer> {
 		const utf8 = this.#encoder.encode(value);
 		if (this.stride.kind === "fixed") {
 			if (utf8.length !== this.stride.size) {

lib/codec.ts

@@ -101,7 +101,7 @@ export abstract class Codec<O extends I = any, I = O> {
 	 * const buf = U32.encode(0xDEADBEEF);
 	 * // buf => Uint8Array [0xDE, 0xAD, 0xBE, 0xEF]
 	 */
-	public abstract encode(value: I): Uint8Array;
+	public abstract encode(value: I): Uint8Array<ArrayBuffer>;
 	public abstract encodeInto(value: I, target: Uint8Array, offset?: number): number;
 
 	/**
@@ -245,7 +245,7 @@ export class TransformCodec<
 	 * @param value - Value to encode.
 	 * @returns Encoded bytes.
 	 */
-	encode(value: I): Uint8Array {
+	encode(value: I): Uint8Array<ArrayBuffer> {
 		return this.inner.encode(value);
 	}
 

lib/composites/array.ts

@@ -145,7 +145,7 @@ export class ArrayCodec<T extends ArrayGeneric, const O extends ArrayOptions | u
 	 * codec.encode([1, 2, 3]); // Uint8Array [1, 2, 3]
 	 * codec.encode([1, 2]);    // throws RangeError
 	 */
-	public encode(value: ArrayInput<T>): Uint8Array {
+	public encode(value: ArrayInput<T>): Uint8Array<ArrayBuffer> {
 		if (this.#elementCount !== undefined) {
 			if (value.length !== this.#elementCount) {
 				throw new RangeError(

lib/composites/enum.ts

@@ -111,7 +111,7 @@ export class EnumCodec<const T extends EnumGeneric> extends Codec<EnumOutput<T>,
 	 * @example
 	 * const bytes = codec.encode({ kind: "Quit", value: null });
 	 */
-	public encode(value: EnumInput<T>): Uint8Array {
+	public encode(value: EnumInput<T>): Uint8Array<ArrayBuffer> {
 		const index = this.keys.indexOf(value.kind);
 		if (index === -1) {
 			throw new Error(`Invalid union variant: ${String(value.kind)}`);

lib/composites/mapping.ts

@@ -88,7 +88,7 @@ export class MappingCodec<const T extends MappingGeneric> extends Codec<MappingO
 	 * @example
 	 * const bytes = codec.encode(new Map([["a", 1]]));
 	 */
-	public encode(value: MappingInput<T>): Uint8Array {
+	public encode(value: MappingInput<T>): Uint8Array<ArrayBuffer> {
 		return this.#entriesCodec.encode(value.entries().toArray() as never);
 	}
 

lib/composites/model.ts

@@ -171,7 +171,7 @@ export class ModelCodec<const T extends ModelGeneric> extends Codec<ModelOutput<
 	 * @example
 	 * const bytes = codec.encode({ id: 1, name: "Alice" });
 	 */
-	public encode(value: ModelInput<T>): Uint8Array {
+	public encode(value: ModelInput<T>): Uint8Array<ArrayBuffer> {
 		if (this.stride.kind === "fixed") {
 			const result = new Uint8Array(this.stride.size);
 			this.encodeInto(value, result);

lib/composites/nullable.ts

@@ -89,7 +89,7 @@ export class NullableCodec<T extends NullableGeneric> extends Codec<NullableOutp
 	 * const bytes = codec.encode(null);   // presence byte = 0x00
 	 * const bytes = codec.encode("hi");   // presence byte = 0x01, then payload
 	 */
-	public encode(value: NullableInput<T>): Uint8Array {
+	public encode(value: NullableInput<T>): Uint8Array<ArrayBuffer> {
 		if (value === null) {
 			const size = this.stride.kind === "fixed" ? this.stride.size : 1;
 			return new Uint8Array(size); // zero-filled by default

lib/composites/padded_enum.ts

@@ -116,7 +116,7 @@ export class PaddedEnumCodec<const T extends PaddedEnumGeneric> extends Codec<En
 	 * const bytes = EventCodec.encode({ kind: "MouseMove", value: { x: 100, y: 200 } });
 	 * // bytes.length === EventCodec.stride.size
 	 */
-	public encode(value: EnumInput<T>): Uint8Array {
+	public encode(value: EnumInput<T>): Uint8Array<ArrayBuffer> {
 		const result = new Uint8Array(this.stride.size);
 		this.encodeInto(value, result);
 		return result;