style nits

Author: ngxson

packages/gguf/src/types.spec.ts

@@ -3,28 +3,28 @@ import type { gguf } from "./gguf";
 import type { GGUFMetadata, GGUFParseOutput, GGUFType } from "./types";
 
 describe("gguf-types", () => {
-	it("gguf() type can be casted (at compile time)", async () => {
+	it("gguf() type can be casted between STRICT and NON_STRICT (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
 		const result: Awaited<ReturnType<typeof gguf>> = null as any;
-		const strictType = result as GGUFParseOutput<GGUFType.strict>;
+		const strictType = result as GGUFParseOutput<GGUFType.STRICT>;
 		// @ts-expect-error because the key "abc" does not exist
 		strictType.metadata.abc = 123;
-		const nonStrictType = result as GGUFParseOutput<GGUFType.nonStrict>;
+		const nonStrictType = result as GGUFParseOutput<GGUFType.NON_STRICT>;
 		nonStrictType.metadata.abc = 123; // PASS, because it can be anything
 		// @ts-expect-error because ArrayBuffer is not a MetadataValue
 		nonStrictType.metadata.fff = ArrayBuffer;
 	});
 
-	it("GGUFType.nonStrict should be correct (at compile time)", async () => {
+	it("GGUFType.NON_STRICT should be correct (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const model: GGUFMetadata<GGUFType.nonStrict> = null as any;
+		const model: GGUFMetadata<GGUFType.NON_STRICT> = null as any;
 		model.kv_count = 123n;
 		model.abc = 456; // PASS, because it can be anything
 	});
 
-	it("GGUFType.strict should be correct (at compile time)", async () => {
+	it("GGUFType.STRICT should be correct (at compile time)", async () => {
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		const model: GGUFMetadata<GGUFType.strict> = null as any;
+		const model: GGUFMetadata<GGUFType.STRICT> = null as any;
 
 		if (model["general.architecture"] === "whisper") {
 			model["encoder.whisper.block_count"] = 0;

packages/gguf/src/types.ts

@@ -111,16 +111,16 @@ export type Whisper = GGUFGeneralInfo<"whisper"> &
 /// Types for parse output
 
 export enum GGUFType {
-	strict,
-	nonStrict,
+	STRICT,
+	NON_STRICT,
 }
 
-export type GGUFMetadata<TGGUFType extends GGUFType = GGUFType.strict> = {
+export type GGUFMetadata<TGGUFType extends GGUFType = GGUFType.STRICT> = {
 	version: Version;
 	tensor_count: bigint;
 	kv_count: bigint;
 } & GGUFModelKV &
-	(TGGUFType extends GGUFType.strict ? unknown : Record<string, MetadataValue>);
+	(TGGUFType extends GGUFType.STRICT ? unknown : Record<string, MetadataValue>);
 
 export type GGUFModelKV = (NoModelMetadata | ModelMetadata) & (NoTokenizer | Tokenizer);
 
@@ -132,7 +132,7 @@ export interface GGUFTensorInfo {
 	offset: bigint;
 }
 
-export interface GGUFParseOutput<TGGUFType extends GGUFType = GGUFType.strict> {
+export interface GGUFParseOutput<TGGUFType extends GGUFType = GGUFType.STRICT> {
 	metadata: GGUFMetadata<TGGUFType>;
 	tensorInfos: GGUFTensorInfo[];
 }