refactor(util): Rename utility types

src/compound/sized_struct.ts

@@ -1,5 +1,5 @@
-import { calculateTotalSize, getBiggestAlignment } from "../util.ts";
-import { type InnerType, type Options, SizedType } from "../types/mod.ts";
+import { type InnerType, type Options, SizedType } from "../mod.ts";
+import { alignmentOf, sizeOf } from "../util.ts";
 import { Struct } from "./mod.ts";
 
 type ReadFn<R> = (dt: DataView, options: Options) => R;
@@ -48,7 +48,7 @@ export class SizedStruct<
   #inner: Partial<Struct<T, V>>;
 
   constructor(input: T, jitEnabled: boolean = true) {
-    super(calculateTotalSize(input), getBiggestAlignment(input));
+    super(sizeOf(input), alignmentOf(input));
     if (jitEnabled) {
       this.#inner = {
         read: createReadMethod(input, false),

src/compound/struct.ts

@@ -1,5 +1,5 @@
 import { type InnerType, type Options, UnsizedType } from "../types/mod.ts";
-import { getBiggestAlignment } from "../util.ts";
+import { alignmentOf } from "../util.ts";
 
 export class Struct<
   T extends Record<string, UnsizedType<unknown>>,
@@ -10,7 +10,7 @@ export class Struct<
   #record: Array<[string, UnsizedType<unknown>]>;
 
   constructor(input: T) {
-    super(getBiggestAlignment(input));
+    super(alignmentOf(input));
     this.#record = Object.entries(input);
   }
 

src/compound/tagged_union.ts

@@ -5,7 +5,7 @@ import {
   UnsizedType,
   type ValueOf,
 } from "../types/mod.ts";
-import { getBiggestAlignment } from "../util.ts";
+import { alignmentOf } from "../util.ts";
 
 type FindDiscriminant<V, D extends number | string> = (variant: V) => D;
 
@@ -39,7 +39,7 @@ export class TaggedUnion<
     variantFinder: FindDiscriminant<V, Keys<T>>,
     discriminant: UnsizedType<string | number> = u8,
   ) {
-    super(getBiggestAlignment(input));
+    super(alignmentOf(input));
     this.#record = input;
     this.#variantFinder = variantFinder;
     this.#discriminant = discriminant;

src/compound/tuple.ts

@@ -1,5 +1,5 @@
 import { type InnerType, type Options, UnsizedType } from "../types/mod.ts";
-import { getBiggestAlignment } from "../util.ts";
+import { alignmentOf } from "../util.ts";
 
 export class Tuple<
   T extends [...UnsizedType<unknown>[]],
@@ -8,7 +8,7 @@ export class Tuple<
   #tupleTypes: T;
   #length: number;
   constructor(types: T) {
-    super(getBiggestAlignment(types));
+    super(alignmentOf(types));
     this.#tupleTypes = types;
     this.#length = types.length;
   }

src/compound/union.ts

@@ -5,7 +5,7 @@ import {
   UnsizedType,
   type ValueOf,
 } from "../types/mod.ts";
-import { getBiggestAlignment } from "../util.ts";
+import { alignmentOf } from "../util.ts";
 
 type FindDiscriminant<V, D extends number> = (variant: V) => D;
 
@@ -24,7 +24,7 @@ export class Union<
     input: T,
     variantFinder: FindDiscriminant<V, Keys<T>>,
   ) {
-    super(getBiggestAlignment(input));
+    super(alignmentOf(input));
     this.#record = input;
     this.#variantFinder = variantFinder;
   }

src/util.ts

@@ -13,17 +13,29 @@ export const isLittleEndian: boolean = (() => {
 export const align = (unaligned: number, alignment: number): number =>
   (unaligned + alignment - 1) & ~(alignment - 1);
 
-type ArrayOrRecord<T> = T[] | Record<string | number, T>;
+type ArrayOrRecord<T> = Array<T> | Record<string | number, T>;
 
-/** Find and returns the biggest alignment out of a record / array of types */
-export const getBiggestAlignment = (
+/** Find and returns the biggest alignment of a record/array of types */
+export const alignmentOf = (
   input: ArrayOrRecord<UnsizedType<unknown>>,
 ): number =>
   Object.values(input)
     .reduce((acc, x) => Math.max(acc, x.byteAlignment), 0);
+/**
+ * Find and returns the biggest alignment of a record/array of types
+ * @deprecated
+ */
+export const getBiggestAlignment = alignmentOf;
 
-export const calculateTotalSize = (
+/** Find and return the unaligned size of a record/array of types */
+export const sizeOf = (
   input: ArrayOrRecord<SizedType<unknown>>,
 ): number =>
   Object.values(input)
     .reduce((acc, x) => acc + x.byteSize, 0);
+
+/**
+ * Find and return the unaligned size of a record/array of types
+ * @deprecated
+ */
+export const calculateTotalSize = sizeOf;