Class LevelDb

constructor

• new LevelDb(
      ldbFileArr: IFile[],
      logFileArr: IFile[],
      manifestFilesArr: IFile[],
      context?: string,
      logger?: ILogger,
  ): LevelDb

  Parameters

  • ldbFileArr: IFile[]
  • logFileArr: IFile[]
  • manifestFilesArr: IFile[]
  • Optionalcontext: string
  • Optionallogger: ILogger

    If provided, logs will go through here. If not present, it will default to console logs. To disable all logging, pass an empty object {}.

  Returns LevelDb

OptionalcompactPointerLevels

OptionalcompactPointerStrings

Optionalcomparator

Optionalcontext

OptionaldeletedFileLevel

OptionaldeletedFileNumber

OptionalerrorMessages

OptionalisInErrorState

keys

OptionallastSequence

ldbFiles

logFiles

logger

OptionallogNumber

manifestFiles

OptionalnewFileLargest

OptionalnewFileLevel

OptionalnewFileNumber

OptionalnewFileSize

OptionalnewFileSmallest

OptionalnextFileNumber

OptionalpreviousLogNumber

index

• get index(): LevelDbIndex | undefined

  Get the file index for lazy loading

  Returns LevelDbIndex | undefined

isLazyMode

• get isLazyMode(): boolean

  Get whether lazy loading mode is enabled

  Returns boolean

keysInMemoryCount

• get keysInMemoryCount(): number

  Get the number of keys currently in memory

  Returns number

addValueFromLog

• addValueFromLog(
      content: Uint8Array,
      index: number,
      length: number,
      context?: string,
      visitorState?: ILevelDbRecordVisitorState,
  ): number

  Parameters

  • content: Uint8Array
  • index: number
  • length: number
  • Optionalcontext: string
  • OptionalvisitorState: ILevelDbRecordVisitorState

  Returns number

addValueFromManifest

• addValueFromManifest(
      content: Uint8Array,
      index: number,
      length: number,
      context?: string,
  ): void

  Parameters

  • content: Uint8Array
  • index: number
  • length: number
  • Optionalcontext: string

  Returns void

clearLoadedKeys

• clearLoadedKeys(): void

  Clear all loaded keys and reset to just the index metadata. Useful for freeing memory after processing a world.

  Returns void

getKey

• getKey(key: string): Promise<false | LevelKeyValue | undefined>

  Get a key's value, loading the containing file if necessary (lazy mode). In non-lazy mode, this is a simple map lookup.

  Parameters

  • key: string

    The key to retrieve

  Returns Promise<false | LevelKeyValue | undefined>

  The LevelKeyValue, false (if deleted), or undefined (if not found)

init

• init(options?: { unloadFilesAfterParse?: boolean }): Promise<void>

  Parameters

  • Optionaloptions: { unloadFilesAfterParse?: boolean }

  Returns Promise<void>

initLazy

• initLazy(options?: ILevelDbInitOptions): Promise<void>

  Initialize in lazy loading mode - only loads manifest metadata. Files are loaded on-demand when keys are requested.

  This dramatically reduces initial memory usage for large worlds. Call loadAllFiles() to fully load everything, or use getKey() for on-demand loading.

  Parameters

  • Optionaloptions: ILevelDbInitOptions

  Returns Promise<void>

loadAllFiles

• loadAllFiles(
      options?: {
          progressCallback?: (
              phase: string,
              current: number,
              total: number,
          ) => void;
          unloadFilesAfterParse?: boolean;
      },
  ): Promise<number>

  Load all files in lazy mode. This is useful after initLazy() when you want to fully populate all keys (e.g., for world enumeration).

  Parameters

  • Optionaloptions: {
        progressCallback?: (
            phase: string,
            current: number,
            total: number,
        ) => void;
        unloadFilesAfterParse?: boolean;
    }

    Options for loading

  Returns Promise<number>

  The number of keys loaded

loadFile

• loadFile(fileIndex: ILevelDbFileIndex | ILevelDbLogIndex): Promise<number>

  Load a specific file's keys into memory. Used for on-demand loading in lazy mode.

  Parameters

  • fileIndex: ILevelDbFileIndex | ILevelDbLogIndex

  Returns Promise<number>

parseIncrementalFile

• parseIncrementalFile(file: IFile): Promise<IChunkCoordinate[]>

  Parse a new or modified LDB/LOG file and return the chunk coordinates affected. This is used for incremental updates when the file system detects new files.

  Parameters

  • file: IFile

    The LDB or LOG file to parse

  Returns Promise<IChunkCoordinate[]>

  Array of unique chunk coordinates affected by keys in this file

parseIndexBytes

• parseIndexBytes(
      data: Uint8Array,
      offset: number,
      length: number,
      indexKeys: { [id: string]: LevelKeyValue | undefined },
      context?: string,
  ): boolean

  Parameters

  • data: Uint8Array
  • offset: number
  • length: number
  • indexKeys: { [id: string]: LevelKeyValue | undefined }
  • Optionalcontext: string

  Returns boolean

parseLdbBlockBytes

• parseLdbBlockBytes(
      data: Uint8Array,
      offset: number,
      length: number,
      context?: string,
      visitorState?: ILevelDbRecordVisitorState,
  ): number

  Parameters

  • data: Uint8Array
  • offset: number
  • length: number
  • Optionalcontext: string
  • OptionalvisitorState: ILevelDbRecordVisitorState

  Returns number

parseLdbContent

• parseLdbContent(
      content: Uint8Array,
      context?: string,
      visitorState?: ILevelDbRecordVisitorState,
  ): number | false | undefined

  Parameters

  • content: Uint8Array
  • Optionalcontext: string
  • OptionalvisitorState: ILevelDbRecordVisitorState

  Returns number | false | undefined

parseLogContent

• parseLogContent(
      content: Uint8Array,
      context?: string,
      visitorState?: ILevelDbRecordVisitorState,
  ): number | undefined

  Parameters

  • content: Uint8Array
  • Optionalcontext: string
  • OptionalvisitorState: ILevelDbRecordVisitorState

  Returns number | undefined

parseManifestContent

• parseManifestContent(content: Uint8Array, context?: string): void

  Parameters

  • content: Uint8Array
  • Optionalcontext: string

  Returns void