@yume-chan/struct 0.0.20 → 0.0.21

package/src/basic/field-value.ts

@@ -13,18 +13,18 @@ export abstract class StructFieldValue<
         any,
         any,
         any
-    > = StructFieldDefinition<any, any, any>
+    > = StructFieldDefinition<any, any, any>,
 > {
     /** Gets the definition associated with this runtime value */
-    public readonly definition: TDefinition;
+    readonly definition: TDefinition;
 
     /** Gets the options of the associated `Struct` */
-    public readonly options: Readonly<StructOptions>;
+    readonly options: Readonly<StructOptions>;
 
     /** Gets the associated `Struct` instance */
-    public readonly struct: StructValue;
+    readonly struct: StructValue;
 
-    public get hasCustomAccessors(): boolean {
+    get hasCustomAccessors(): boolean {
         return (
             this.get !== StructFieldValue.prototype.get ||
             this.set !== StructFieldValue.prototype.set
@@ -33,11 +33,11 @@ export abstract class StructFieldValue<
 
     protected value: TDefinition["TValue"];
 
-    public constructor(
+    constructor(
         definition: TDefinition,
         options: Readonly<StructOptions>,
         struct: StructValue,
-        value: TDefinition["TValue"]
+        value: TDefinition["TValue"],
     ) {
         this.definition = definition;
         this.options = options;
@@ -50,26 +50,26 @@ export abstract class StructFieldValue<
      *
      * When overridden in derived classes, can have custom logic to calculate the actual size.
      */
-    public getSize(): number {
+    getSize(): number {
         return this.definition.getSize();
     }
 
     /**
      * When implemented in derived classes, reads current field's value.
      */
-    public get(): TDefinition["TValue"] {
+    get(): TDefinition["TValue"] {
         return this.value;
     }
 
     /**
      * When implemented in derived classes, updates current field's value.
      */
-    public set(value: TDefinition["TValue"]): void {
+    set(value: TDefinition["TValue"]): void {
         this.value = value;
     }
 
     /**
      * When implemented in derived classes, serializes this field into `dataView` at `offset`
      */
-    public abstract serialize(dataView: DataView, offset: number): void;
+    abstract serialize(dataView: DataView, offset: number): void;
 }

package/src/basic/stream.ts

@@ -3,7 +3,7 @@ import type { ValueOrPromise } from "../utils.js";
 // TODO: allow over reading (returning a `Uint8Array`, an `offset` and a `length`) to avoid copying
 
 export class ExactReadableEndedError extends Error {
-    public constructor() {
+    constructor() {
         super("ExactReadable ended");
         Object.setPrototypeOf(this, new.target.prototype);
     }

package/src/basic/struct-value.ts

@@ -14,9 +14,9 @@ export class StructValue {
     /**
      * Gets the result struct value object
      */
-    public readonly value: Record<PropertyKey, unknown>;
+    readonly value: Record<PropertyKey, unknown>;
 
-    public constructor(prototype: object) {
+    constructor(prototype: object) {
         // PERF: `Object.create(extra)` is 50% faster
         // than `Object.defineProperties(this.value, extra)`
         this.value = Object.create(prototype) as Record<PropertyKey, unknown>;
@@ -35,7 +35,7 @@ export class StructValue {
      * @param name The field name
      * @param fieldValue The associated `StructFieldValue`
      */
-    public set(name: PropertyKey, fieldValue: StructFieldValue): void {
+    set(name: PropertyKey, fieldValue: StructFieldValue): void {
         this.fieldValues[name] = fieldValue;
 
         // PERF: `Object.defineProperty` is slow
@@ -61,7 +61,7 @@ export class StructValue {
      *
      * @param name The field name
      */
-    public get(name: PropertyKey): StructFieldValue {
+    get(name: PropertyKey): StructFieldValue {
         return this.fieldValues[name]!;
     }
 }

package/src/struct.ts

@@ -50,7 +50,7 @@ type AddFieldDescriptor<
     TExtra extends object,
     TPostDeserialized,
     TFieldName extends PropertyKey,
-    TDefinition extends StructFieldDefinition<any, any, any>
+    TDefinition extends StructFieldDefinition<any, any, any>,
 > = Identity<
     Struct<
         // Merge two types
@@ -70,7 +70,7 @@ interface ArrayBufferLikeFieldCreator<
     TFields extends object,
     TOmitInitKey extends PropertyKey,
     TExtra extends object,
-    TPostDeserialized
+    TPostDeserialized,
 > {
     /**
      * Append a fixed-length array buffer like field to the `Struct`
@@ -84,12 +84,12 @@ interface ArrayBufferLikeFieldCreator<
     <
         TName extends PropertyKey,
         TType extends BufferFieldSubType<any, any>,
-        TTypeScriptType = TType["TTypeScriptType"]
+        TTypeScriptType = TType["TTypeScriptType"],
     >(
         name: TName,
         type: TType,
         options: FixedLengthBufferLikeFieldOptions,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ): AddFieldDescriptor<
         TFields,
         TOmitInitKey,
@@ -109,12 +109,12 @@ interface ArrayBufferLikeFieldCreator<
         TName extends PropertyKey,
         TType extends BufferFieldSubType<any, any>,
         TOptions extends VariableLengthBufferLikeFieldOptions<TFields>,
-        TTypeScriptType = TType["TTypeScriptType"]
+        TTypeScriptType = TType["TTypeScriptType"],
     >(
         name: TName,
         type: TType,
         options: TOptions,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ): AddFieldDescriptor<
         TFields,
         TOmitInitKey,
@@ -133,12 +133,12 @@ interface BoundArrayBufferLikeFieldDefinitionCreator<
     TOmitInitKey extends PropertyKey,
     TExtra extends object,
     TPostDeserialized,
-    TType extends BufferFieldSubType<any, any>
+    TType extends BufferFieldSubType<any, any>,
 > {
     <TName extends PropertyKey, TTypeScriptType = TType["TTypeScriptType"]>(
         name: TName,
         options: FixedLengthBufferLikeFieldOptions,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ): AddFieldDescriptor<
         TFields,
         TOmitInitKey,
@@ -159,11 +159,11 @@ interface BoundArrayBufferLikeFieldDefinitionCreator<
             TFields,
             TLengthField
         >,
-        TTypeScriptType = TType["TTypeScriptType"]
+        TTypeScriptType = TType["TTypeScriptType"],
     >(
         name: TName,
         options: TOptions,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ): AddFieldDescriptor<
         TFields,
         TOmitInitKey,
@@ -180,34 +180,34 @@ interface BoundArrayBufferLikeFieldDefinitionCreator<
 
 export type StructPostDeserialized<TFields, TPostDeserialized> = (
     this: TFields,
-    object: TFields
+    object: TFields,
 ) => TPostDeserialized;
 
 export type StructDeserializedResult<
     TFields extends object,
     TExtra extends object,
-    TPostDeserialized
+    TPostDeserialized,
 > = TPostDeserialized extends undefined
     ? Overwrite<TExtra, TFields>
     : TPostDeserialized;
 
 export class StructDeserializeError extends Error {
-    public constructor(message: string) {
+    constructor(message: string) {
         super(message);
         Object.setPrototypeOf(this, new.target.prototype);
     }
 }
 
 export class StructNotEnoughDataError extends StructDeserializeError {
-    public constructor() {
+    constructor() {
         super(
-            "The underlying readable was ended before the struct was fully deserialized"
+            "The underlying readable was ended before the struct was fully deserialized",
         );
     }
 }
 
 export class StructEmptyError extends StructDeserializeError {
-    public constructor() {
+    constructor() {
         super("The underlying readable doesn't contain any more struct");
     }
 }
@@ -216,43 +216,43 @@ export class Struct<
     TFields extends object = Record<never, never>,
     TOmitInitKey extends PropertyKey = never,
     TExtra extends object = Record<never, never>,
-    TPostDeserialized = undefined
+    TPostDeserialized = undefined,
 > implements
         StructLike<
             StructDeserializedResult<TFields, TExtra, TPostDeserialized>
         >
 {
-    public readonly TFields!: TFields;
+    readonly TFields!: TFields;
 
-    public readonly TOmitInitKey!: TOmitInitKey;
+    readonly TOmitInitKey!: TOmitInitKey;
 
-    public readonly TExtra!: TExtra;
+    readonly TExtra!: TExtra;
 
-    public readonly TInit!: Evaluate<Omit<TFields, TOmitInitKey>>;
+    readonly TInit!: Evaluate<Omit<TFields, TOmitInitKey>>;
 
-    public readonly TDeserializeResult!: StructDeserializedResult<
+    readonly TDeserializeResult!: StructDeserializedResult<
         TFields,
         TExtra,
         TPostDeserialized
     >;
 
-    public readonly options: Readonly<StructOptions>;
+    readonly options: Readonly<StructOptions>;
 
     #size = 0;
     /**
      * Gets the static size (exclude fields that can change size at runtime)
      */
-    public get size() {
+    get size() {
         return this.#size;
     }
 
     #fields: [
         name: PropertyKey,
-        definition: StructFieldDefinition<any, any, any>
+        definition: StructFieldDefinition<any, any, any>,
     ][] = [];
-    public get fields(): readonly [
+    get fields(): readonly [
         name: PropertyKey,
-        definition: StructFieldDefinition<any, any, any>
+        definition: StructFieldDefinition<any, any, any>,
     ][] {
         return this.#fields;
     }
@@ -261,19 +261,19 @@ export class Struct<
 
     #postDeserialized?: StructPostDeserialized<any, any> | undefined;
 
-    public constructor(options?: Partial<Readonly<StructOptions>>) {
+    constructor(options?: Partial<Readonly<StructOptions>>) {
         this.options = { ...StructDefaultOptions, ...options };
     }
 
     /**
      * Appends a `StructFieldDefinition` to the `Struct
      */
-    public field<
+    field<
         TName extends PropertyKey,
-        TDefinition extends StructFieldDefinition<any, any, any>
+        TDefinition extends StructFieldDefinition<any, any, any>,
     >(
         name: TName,
-        definition: TDefinition
+        definition: TDefinition,
     ): AddFieldDescriptor<
         TFields,
         TOmitInitKey,
@@ -287,7 +287,7 @@ export class Struct<
                 // Convert Symbol to string
                 const nameString = String(name);
                 throw new Error(
-                    `This struct already have a field with name '${nameString}'`
+                    `This struct already have a field with name '${nameString}'`,
                 );
             }
         }
@@ -304,8 +304,8 @@ export class Struct<
     /**
      * Merges (flats) another `Struct`'s fields and extra fields into this one.
      */
-    public concat<TOther extends Struct<any, any, any, any>>(
-        other: TOther
+    concat<TOther extends Struct<any, any, any, any>>(
+        other: TOther,
     ): Struct<
         TFields & TOther["TFields"],
         TOmitInitKey | TOther["TOmitInitKey"],
@@ -318,90 +318,90 @@ export class Struct<
         this.#size += other.#size;
         Object.defineProperties(
             this.#extra,
-            Object.getOwnPropertyDescriptors(other.#extra)
+            Object.getOwnPropertyDescriptors(other.#extra),
         );
         return this as any;
     }
 
-    private number<
+    #number<
         TName extends PropertyKey,
         TType extends NumberFieldType = NumberFieldType,
-        TTypeScriptType = number
+        TTypeScriptType = number,
     >(name: TName, type: TType, typeScriptType?: TTypeScriptType) {
         return this.field(
             name,
-            new NumberFieldDefinition(type, typeScriptType)
+            new NumberFieldDefinition(type, typeScriptType),
         );
     }
 
     /**
      * Appends an `int8` field to the `Struct`
      */
-    public int8<TName extends PropertyKey, TTypeScriptType = number>(
+    int8<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Int8, typeScriptType);
+        return this.#number(name, NumberFieldType.Int8, typeScriptType);
     }
 
     /**
      * Appends an `uint8` field to the `Struct`
      */
-    public uint8<TName extends PropertyKey, TTypeScriptType = number>(
+    uint8<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Uint8, typeScriptType);
+        return this.#number(name, NumberFieldType.Uint8, typeScriptType);
     }
 
     /**
      * Appends an `int16` field to the `Struct`
      */
-    public int16<TName extends PropertyKey, TTypeScriptType = number>(
+    int16<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Int16, typeScriptType);
+        return this.#number(name, NumberFieldType.Int16, typeScriptType);
     }
 
     /**
      * Appends an `uint16` field to the `Struct`
      */
-    public uint16<TName extends PropertyKey, TTypeScriptType = number>(
+    uint16<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Uint16, typeScriptType);
+        return this.#number(name, NumberFieldType.Uint16, typeScriptType);
     }
 
     /**
      * Appends an `int32` field to the `Struct`
      */
-    public int32<TName extends PropertyKey, TTypeScriptType = number>(
+    int32<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Int32, typeScriptType);
+        return this.#number(name, NumberFieldType.Int32, typeScriptType);
     }
 
     /**
      * Appends an `uint32` field to the `Struct`
      */
-    public uint32<TName extends PropertyKey, TTypeScriptType = number>(
+    uint32<TName extends PropertyKey, TTypeScriptType = number>(
         name: TName,
-        typeScriptType?: TTypeScriptType
+        typeScriptType?: TTypeScriptType,
     ) {
-        return this.number(name, NumberFieldType.Uint32, typeScriptType);
+        return this.#number(name, NumberFieldType.Uint32, typeScriptType);
     }
 
-    private bigint<
+    #bigint<
         TName extends PropertyKey,
         TType extends BigIntFieldType = BigIntFieldType,
-        TTypeScriptType = TType["TTypeScriptType"]
+        TTypeScriptType = TType["TTypeScriptType"],
     >(name: TName, type: TType, typeScriptType?: TTypeScriptType) {
         return this.field(
             name,
-            new BigIntFieldDefinition(type, typeScriptType)
+            new BigIntFieldDefinition(type, typeScriptType),
         );
     }
 
@@ -410,11 +410,11 @@ export class Struct<
      *
      * Requires native `BigInt` support
      */
-    public int64<
+    int64<
         TName extends PropertyKey,
-        TTypeScriptType = BigIntFieldType["TTypeScriptType"]
+        TTypeScriptType = BigIntFieldType["TTypeScriptType"],
     >(name: TName, typeScriptType?: TTypeScriptType) {
-        return this.bigint(name, BigIntFieldType.Int64, typeScriptType);
+        return this.#bigint(name, BigIntFieldType.Int64, typeScriptType);
     }
 
     /**
@@ -422,14 +422,14 @@ export class Struct<
      *
      * Requires native `BigInt` support
      */
-    public uint64<
+    uint64<
         TName extends PropertyKey,
-        TTypeScriptType = BigIntFieldType["TTypeScriptType"]
+        TTypeScriptType = BigIntFieldType["TTypeScriptType"],
     >(name: TName, typeScriptType?: TTypeScriptType) {
-        return this.bigint(name, BigIntFieldType.Uint64, typeScriptType);
+        return this.#bigint(name, BigIntFieldType.Uint64, typeScriptType);
     }
 
-    private arrayBufferLike: ArrayBufferLikeFieldCreator<
+    #arrayBufferLike: ArrayBufferLikeFieldCreator<
         TFields,
         TOmitInitKey,
         TExtra,
@@ -439,48 +439,48 @@ export class Struct<
         type: BufferFieldSubType,
         options:
             | FixedLengthBufferLikeFieldOptions
-            | VariableLengthBufferLikeFieldOptions
+            | VariableLengthBufferLikeFieldOptions,
     ): any => {
         if ("length" in options) {
             return this.field(
                 name,
-                new FixedLengthBufferLikeFieldDefinition(type, options)
+                new FixedLengthBufferLikeFieldDefinition(type, options),
             );
         } else {
             return this.field(
                 name,
-                new VariableLengthBufferLikeFieldDefinition(type, options)
+                new VariableLengthBufferLikeFieldDefinition(type, options),
             );
         }
     };
 
-    public uint8Array: BoundArrayBufferLikeFieldDefinitionCreator<
+    uint8Array: BoundArrayBufferLikeFieldDefinitionCreator<
         TFields,
         TOmitInitKey,
         TExtra,
         TPostDeserialized,
         Uint8ArrayBufferFieldSubType
     > = (name: PropertyKey, options: any, typeScriptType: any): any => {
-        return this.arrayBufferLike(
+        return this.#arrayBufferLike(
             name,
             Uint8ArrayBufferFieldSubType.Instance,
             options,
-            typeScriptType
+            typeScriptType,
         );
     };
 
-    public string: BoundArrayBufferLikeFieldDefinitionCreator<
+    string: BoundArrayBufferLikeFieldDefinitionCreator<
         TFields,
         TOmitInitKey,
         TExtra,
         TPostDeserialized,
         StringBufferFieldSubType
     > = (name: PropertyKey, options: any, typeScriptType: any): any => {
-        return this.arrayBufferLike(
+        return this.#arrayBufferLike(
             name,
             StringBufferFieldSubType.Instance,
             options,
-            typeScriptType
+            typeScriptType,
         );
     };
 
@@ -494,18 +494,18 @@ export class Struct<
      * @param value
      * An object containing properties to be added to the result value. Accessors and methods are also allowed.
      */
-    public extra<
+    extra<
         T extends Record<
             // This trick disallows any keys that are already in `TValue`
             Exclude<keyof T, Exclude<keyof T, keyof TFields>>,
             never
-        >
+        >,
     >(
-        value: T & ThisType<Overwrite<Overwrite<TExtra, T>, TFields>>
+        value: T & ThisType<Overwrite<Overwrite<TExtra, T>, TFields>>,
     ): Struct<TFields, TOmitInitKey, Overwrite<TExtra, T>, TPostDeserialized> {
         Object.defineProperties(
             this.#extra,
-            Object.getOwnPropertyDescriptors(value)
+            Object.getOwnPropertyDescriptors(value),
         );
         return this as any;
     }
@@ -516,8 +516,8 @@ export class Struct<
      * A callback returning `never` (always throw an error)
      * will also change the return type of `deserialize` to `never`.
      */
-    public postDeserialize(
-        callback: StructPostDeserialized<TFields, never>
+    postDeserialize(
+        callback: StructPostDeserialized<TFields, never>,
     ): Struct<TFields, TOmitInitKey, TExtra, never>;
     /**
      * Registers (or replaces) a custom callback to be run after deserialized.
@@ -525,8 +525,8 @@ export class Struct<
      * A callback returning `void` means it modify the result object in-place
      * (or doesn't modify it at all), so `deserialize` will still return the result object.
      */
-    public postDeserialize(
-        callback?: StructPostDeserialized<TFields, void>
+    postDeserialize(
+        callback?: StructPostDeserialized<TFields, void>,
     ): Struct<TFields, TOmitInitKey, TExtra, undefined>;
     /**
      * Registers (or replaces) a custom callback to be run after deserialized.
@@ -534,10 +534,10 @@ export class Struct<
      * A callback returning anything other than `undefined`
      * will `deserialize` to return that object instead.
      */
-    public postDeserialize<TPostSerialize>(
-        callback?: StructPostDeserialized<TFields, TPostSerialize>
+    postDeserialize<TPostSerialize>(
+        callback?: StructPostDeserialized<TFields, TPostSerialize>,
     ): Struct<TFields, TOmitInitKey, TExtra, TPostSerialize>;
-    public postDeserialize(callback?: StructPostDeserialized<TFields, any>) {
+    postDeserialize(callback?: StructPostDeserialized<TFields, any>) {
         this.#postDeserialized = callback;
         return this as any;
     }
@@ -545,14 +545,14 @@ export class Struct<
     /**
      * Deserialize a struct value from `stream`.
      */
-    public deserialize(
-        stream: ExactReadable
+    deserialize(
+        stream: ExactReadable,
     ): StructDeserializedResult<TFields, TExtra, TPostDeserialized>;
-    public deserialize(
-        stream: AsyncExactReadable
+    deserialize(
+        stream: AsyncExactReadable,
     ): Promise<StructDeserializedResult<TFields, TExtra, TPostDeserialized>>;
-    public deserialize(
-        stream: ExactReadable | AsyncExactReadable
+    deserialize(
+        stream: ExactReadable | AsyncExactReadable,
     ): ValueOrPromise<
         StructDeserializedResult<TFields, TExtra, TPostDeserialized>
     > {
@@ -564,7 +564,7 @@ export class Struct<
         for (const [name, definition] of this.#fields) {
             promise = promise
                 .then(() =>
-                    definition.deserialize(this.options, stream, structValue)
+                    definition.deserialize(this.options, stream, structValue),
                 )
                 .then(
                     (fieldValue) => {
@@ -580,7 +580,7 @@ export class Struct<
                         } else {
                             throw new StructNotEnoughDataError();
                         }
-                    }
+                    },
                 );
         }
 
@@ -603,14 +603,14 @@ export class Struct<
             .valueOrPromise();
     }
 
-    public serialize(init: Evaluate<Omit<TFields, TOmitInitKey>>): Uint8Array;
-    public serialize(
+    serialize(init: Evaluate<Omit<TFields, TOmitInitKey>>): Uint8Array;
+    serialize(
         init: Evaluate<Omit<TFields, TOmitInitKey>>,
-        output: Uint8Array
+        output: Uint8Array,
     ): number;
-    public serialize(
+    serialize(
         init: Evaluate<Omit<TFields, TOmitInitKey>>,
-        output?: Uint8Array
+        output?: Uint8Array,
     ): Uint8Array | number {
         let structValue: StructValue;
         if (STRUCT_VALUE_SYMBOL in init) {
@@ -627,7 +627,7 @@ export class Struct<
                 const fieldValue = definition.create(
                     this.options,
                     structValue,
-                    (init as any)[name]
+                    (init as any)[name],
                 );
                 structValue.set(name, fieldValue);
             }
@@ -652,7 +652,7 @@ export class Struct<
         const dataView = new DataView(
             output.buffer,
             output.byteOffset,
-            output.byteLength
+            output.byteLength,
         );
         let offset = 0;
         for (const { fieldValue, size } of fieldsInfo) {