Class BlobStore

Index

Constructors

constructor

new BlobStore(options): BlobStore
Parameters
- options: {
  coreManager: CoreManager;
  }
  - coreManager: CoreManager
Returns BlobStore

Accessors

writerDriveId

get writerDriveId(): string
Returns string

Methods

clear

clear(blobId, options?): Promise<null | {
blocks: number;
}>
Parameters
- blobId: BlobId
- Optionaloptions: {
  diff: undefined | boolean;
  } = {}
  - diff: undefined | boolean
    Enable to return an object with a block property with number of bytes removed
Returns Promise<null | {
blocks: number;
}>

createEntryReadStream

createEntryReadStream(driveId, entry, options?): Promise<BlobReadStream>
Optimization for creating the blobs read stream when you have previously read the entry from Hyperdrive using drive.entry
Parameters
- driveId: string
  Hyperdrive drive discovery id
- entry: HyperdriveEntry
  Hyperdrive entry
- Optionaloptions: {
  wait: undefined | boolean;
  } = ...
  - wait: undefined | boolean
    Set to true to wait for a blob to download, otherwise will throw if blob is not available locally
Returns Promise<BlobReadStream>

createReadStream

createReadStream(blobId, options?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- blobId: BlobId
- Optionaloptions: {
  timeout: undefined | number;
  wait: undefined | boolean;
  } = ...
  - timeout: undefined | number
    Optional timeout to wait for a blob to download
  - wait: undefined | boolean
    Set to true to wait for a blob to download, otherwise will throw if blob is not available locally
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

createWriteStream

createWriteStream(blobId, options?): Writable<any, any, any, false, true, WritableEvents<any>> & {
driveId: string;
}
Parameters
- blobId: Omit<BlobId, "driveId">
- Optionaloptions: {
      metadata: undefined | {
          mimeType: string;
      };
  }
  - metadata: undefined | {
    mimeType: string;
    }
    Metadata to store with the blob
Returns Writable<any, any, any, false, true, WritableEvents<any>> & {
driveId: string;
}

download

download(filter?, options?): LiveDownload
Download blobs from all drives, optionally filtering particular blob types or blob variants. Download will be 'live' and will continue downloading new data as it becomes available from any replicating drive.

If no filter is specified, all blobs will be downloaded. If a filter is specified, then only blobs that match the filter will be downloaded.
Parameters
- Optionalfilter: BlobFilter
  Filter blob types and/or variants to download. Filter is { [BlobType]: BlobVariants[] }. At least one blob variant must be specified for each blob type.
- options: {
  signal: undefined | AbortSignal;
  } = {}
  - signal: undefined | AbortSignal
    Optional AbortSignal to cancel in-progress download
Returns LiveDownload
EventEmitter with .state propery, emits state with new state when it updates

entry

entry(blobId, options?): Promise<null | HyperdriveEntry>
Parameters
- blobId: BlobId
- Optionaloptions: {
      follow: undefined | boolean;
      timeout: undefined;
      wait: undefined | false;
  } = ...
  - follow: undefined | boolean
    Set to true to follow symlinks (16 max or throws an error)
  - timeout: undefined
    Optional timeout to wait for a blob to download
  - wait: undefined | false
    Set to true to wait for a blob to download, otherwise will throw if blob is not available locally
Returns Promise<null | HyperdriveEntry>

get

get(blobId, opts?): Promise<Buffer>
Parameters
- blobId: BlobId
- opts: {
  timeout: undefined;
  wait: undefined | false;
  } = {}
  - timeout: undefined
    Optional timeout to wait for a blob to download
  - wait: undefined | false
    Set to true to wait for a blob to download, otherwise will throw if blob is not available locally
Returns Promise<Buffer>

getEntryBlob

getEntryBlob(driveId, entry, opts?): Promise<null | Buffer>
Parameters
- driveId: string
  Hyperdrive drive id
- entry: HyperdriveEntry
  Hyperdrive entry
- Optionalopts: {
  length: undefined | number;
  } = {}
  - length: undefined | number
Returns Promise<null | Buffer>

put

put(blobId, blob, options?): Promise<string>
Parameters
- blobId: Omit<BlobId, "driveId">
- blob: Buffer
- Optionaloptions: {
      metadata: undefined | {
          mimeType: string;
      };
  }
  - metadata: undefined | {
    mimeType: string;
    }
    Metadata to store with the blob
Returns Promise<string>
discovery key as hex string of hyperdrive where blob is stored

Class BlobStore

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

coreManager: CoreManager

Returns BlobStore

Accessors

writerDriveId

Returns string

Methods

clear

Parameters

diff: undefined | boolean

Returns Promise<null | { blocks: number; }>

createEntryReadStream

Parameters

wait: undefined | boolean

Returns Promise<BlobReadStream>

createReadStream

Parameters

timeout: undefined | number

wait: undefined | boolean

Returns Readable<any, any, any, true, false, ReadableEvents<any>>

createWriteStream

Parameters

metadata: undefined | { mimeType: string; }

Returns Writable<any, any, any, false, true, WritableEvents<any>> & { driveId: string; }

download

Parameters

signal: undefined | AbortSignal

Returns LiveDownload

entry

Parameters

follow: undefined | boolean

timeout: undefined

wait: undefined | false

Returns Promise<null | HyperdriveEntry>

get

Parameters

timeout: undefined

wait: undefined | false

Returns Promise<Buffer>

getEntryBlob

Parameters

length: undefined | number

Returns Promise<null | Buffer>

put

Parameters

metadata: undefined | { mimeType: string; }

Returns Promise<string>

Settings

On This Page

Returns Promise<null | {
blocks: number;
}>

metadata: undefined | {
mimeType: string;
}

Returns Writable<any, any, any, false, true, WritableEvents<any>> & {
driveId: string;
}

metadata: undefined | {
mimeType: string;
}