Class LocalStorage

constructor

• new LocalStorage(dir): LocalStorage

• Parameters

  • dir: string

  Returns LocalStorage

dir

files

log

getBlobSize

• getBlobSize(sha256): Promise<number>

• get the size of the stored blob

  Parameters

  • sha256: string

  Returns Promise<number>

getBlobType

• getBlobType(sha256): undefined | string | Promise<undefined | string>

• get the MIME type of the blob if the storage knows it

  Parameters

  • sha256: string

  Returns undefined | string | Promise<undefined | string>

hasBlob

• hasBlob(hash): Promise<boolean>

• check if blob exists in storage

  Parameters

  • hash: string

  Returns Promise<boolean>

listBlobs

• listBlobs(): Promise<string[]>

• lists all hashes

  Returns Promise<string[]>

readBlob

• readBlob(hash): Promise<Readable>

• returns the blob contents as a Readable stream

  Parameters

  • hash: string

  Returns Promise<Readable>

removeBlob

• removeBlob(sha256): Promise<void>

• remove a blob from storage

  Parameters

  • sha256: string

  Returns Promise<void>

setup

• setup(): Promise<void>

• setup storage

  Returns Promise<void>

writeBlob

• writeBlob(sha256, stream, type?): Promise<void>

• save blob

  Parameters

  • sha256: string
  • stream: Readable | Buffer
  • Optional type: string

  Returns Promise<void>