Module metanome/IndexFile

Index

Functions

Functions

addToIndex

addToIndex(entry: IIndexFileEntry): Promise<void>

- Defined in metanome/IndexFile.ts:49
This should rarely be called directly, but via MetanomeAlgorithn.addToIndex! It takes an entry and adds it to the index file once a lock could be aqcuired

Parameters
- entry: IIndexFileEntry
Returns Promise<void>
Promise that resolves after file was edited

deleteFromIndex

deleteFromIndex(fileName: string): Promise<boolean>

- Defined in metanome/IndexFile.ts:67
Deletes this file from the metanome index file ATTENTION: THIS WONT DELETE THE FILE ITSELF This is done so that this operation is as atomic as possible, and is either completely clears or completely fails, but doen't leave corrupted state. The calling context is responsible for making sure both actions succeed

Parameters
- fileName: string
  
  name of the file to be deleted (without folders)
Returns Promise<boolean>
Promise. Resolves to true if something was deleted, false otherwise

getIndexContent

getIndexContent(getAll?: boolean): Promise<IIndexFileEntry[]>

- Defined in metanome/IndexFile.ts:22
Parameters
- getAll: boolean = false
  
  if false (delfault) only gets entries for current database
Returns Promise<IIndexFileEntry[]>

Generated using TypeDoc