@zebbedaja/er-save-parser 0.1.0 → 0.1.2

package/README.md

@@ -33,8 +33,14 @@ import { parse, type Save, type Slot, type Character } from '@zebbedaja/er-save-
 import { readFileSync } from 'fs'
 
 const buffer = readFileSync('ER0000.sl2').buffer
+
+// Default: only errors are logged (logLevel: 'error')
 const save: Save = parse(buffer)
 
+// Optional: configure logging with one of 'debug', 'info', 'warn', 'error', 'none'
+// const save: Save = parse(buffer, { logLevel: 'debug' }) // Verbose progress logs
+// const save: Save = parse(buffer, { logLevel: 'none' })   // Silent
+
 console.log(save.steamId)
 console.log(save.settings?.hud)
 
@@ -65,8 +71,14 @@ import { parse } from '@zebbedaja/er-save-parser'
 import { readFileSync } from 'node:fs'
 
 const buffer = readFileSync('ER0000.sl2').buffer
+
+// Default: only errors are logged (logLevel: 'error')
 const save = parse(buffer)
 
+// Optional: configure logging with one of 'debug', 'info', 'warn', 'error', 'none'
+// const save = parse(buffer, { logLevel: 'debug' }) // Verbose progress logs
+// const save = parse(buffer, { logLevel: 'none' })   // Silent
+
 console.log(save.steamId)
 console.log(save.settings?.hud)
 

package/dist/index.d.mts

@@ -1,4 +1,8 @@
 //#region src/types.d.ts
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+interface ParseOptions {
+  logLevel?: LogLevel;
+}
 interface Save {
   magicBytes?: string;
   checksum?: string;
@@ -139,6 +143,14 @@ interface EventFlag {
 }
 //#endregion
 //#region src/parser.d.ts
-declare function parse(buffer: ArrayBuffer): Save;
+/**
+ * Parse an Elden Ring save file buffer.
+ *
+ * @param buffer - The ArrayBuffer containing the save file data
+ * @param options - Optional configuration for parsing
+ * @param options.logLevel - Log level threshold: 'debug', 'info', 'warn', 'error', or 'none'. Defaults to 'error'
+ * @returns A Save object containing parsed slot and profile data
+ */
+declare function parse(buffer: ArrayBuffer, options?: ParseOptions): Save;
 //#endregion
-export { type Character, type EventFlag, type ProfileSummary, type Save, type Settings, type Slot, parse };
+export { type Character, type EventFlag, type LogLevel, type ParseOptions, type ProfileSummary, type Save, type Settings, type Slot, parse };