Class Hyperblobs

constructor

• new Hyperblobs(core, opts?): Hyperblobs

• Parameters

  • core: Hypercore<"binary", undefined>
  • Optionalopts: {
        blocksize?: number;
    }

    • Optionalblocksize?: number

  Returns Hyperblobs

ReadonlyblockSize

Readonlycore

feed

• get feed(): Hypercore<"binary", undefined>

• Returns Hypercore<"binary", undefined>

locked

• get locked(): boolean

• Returns boolean

clear

• clear(id, opts?): Promise<null | {
      blocks: number;
  }>

• Parameters

  • id: Hyperblobs.BlobId
  • Optionalopts: {
        diff?: boolean;
    }

    • Optionaldiff?: boolean

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

createReadStream

• createReadStream(id, opts?): BlobReadStream

• Parameters

  • id: Hyperblobs.BlobId
  • Optionalopts: any

  Returns BlobReadStream

createWriteStream

• createWriteStream(opts?): BlobWriteStream

• Parameters

  • Optionalopts: any

  Returns BlobWriteStream

get

• get(id, opts?): Promise<null | Buffer>

• Parameters

  • id: Hyperblobs.BlobId
  • Optionalopts: any

  Returns Promise<null | Buffer>

put

• put(blob, opts?): Promise<Hyperblobs.BlobId>

• Parameters

  • blob: Buffer
  • Optionalopts: {
        blockSize?: number;
        core?: Hypercore<"binary", undefined>;
        end?: number;
        length?: number;
        start?: number;
    }

    • OptionalblockSize?: number

    • Optionalcore?: Hypercore<"binary", undefined>

    • Optionalend?: number

    • Optionallength?: number

    • Optionalstart?: number

  Returns Promise<Hyperblobs.BlobId>