Class Hyperbee<T>

constructor

• new Hyperbee<T>(core, options?): Hyperbee<T>

• Type Parameters

  • T = any

  Parameters

  • core: Hypercore<"binary", undefined>
  • Optionaloptions: HyperbeeOptions<T>

  Returns Hyperbee<T>

Readonlycore

Readonlyversion

batch

• batch(): HyperbeeBatch<T>

• Returns HyperbeeBatch<T>

checkout

• checkout(version): Hyperbee<any>

• Parameters

  • version: number

  Returns Hyperbee<any>

close

• close(): Promise<void>

• Returns Promise<void>

createDiffStream

• createDiffStream(otherVersion, options?): Readable<DiffStreamEntry<T>, DiffStreamEntry<T>, DiffStreamEntry<T>, true, false, ReadableEvents<DiffStreamEntry<T>>>

• Parameters

  • otherVersion: number
  • Optionaloptions: DiffStreamOptions

  Returns Readable<DiffStreamEntry<T>, DiffStreamEntry<T>, DiffStreamEntry<T>, true, false, ReadableEvents<DiffStreamEntry<T>>>

createHistoryStream

• createHistoryStream(options?): Readable<HyperbeeEntry<T> & {
      type: "del" | "put";
  }, HyperbeeEntry<T> & {
      type: "del" | "put";
  }, HyperbeeEntry<T> & {
      type: "del" | "put";
  }, true, false, ReadableEvents<HyperbeeEntry<T> & {
      type: "del" | "put";
  }>>

• Parameters

  • Optionaloptions: HistoryStreamOptions

  Returns Readable<HyperbeeEntry<T> & {
      type: "del" | "put";
  }, HyperbeeEntry<T> & {
      type: "del" | "put";
  }, HyperbeeEntry<T> & {
      type: "del" | "put";
  }, true, false, ReadableEvents<HyperbeeEntry<T> & {
      type: "del" | "put";
  }>>

createReadStream

• createReadStream(range?, options?): Readable<HyperbeeEntry<T>, HyperbeeEntry<T>, HyperbeeEntry<T>, true, false, ReadableEvents<HyperbeeEntry<T>>>

• Parameters

  • Optionalrange: ReadStreamRange
  • Optionaloptions: ReadStreamOptions

  Returns Readable<HyperbeeEntry<T>, HyperbeeEntry<T>, HyperbeeEntry<T>, true, false, ReadableEvents<HyperbeeEntry<T>>>

del

• del(key, options?): Promise<void>

• Parameters

  • key: string
  • Optionaloptions: DelOptions<T>

  Returns Promise<void>

get

• get(key): Promise<null | HyperbeeEntry<T>>

• Parameters

  • key: string

  Returns Promise<null | HyperbeeEntry<T>>

getAndWatch

• getAndWatch(key, options?): Promise<EntryWatcher<T>>

• Parameters

  • key: string
  • Optionaloptions: GetAndWatchOptions

  Returns Promise<EntryWatcher<T>>

getHeader

• getHeader(options?): Promise<any>

• Parameters

  • Optionaloptions: any

  Returns Promise<any>

peek

• peek(range?, options?): Promise<null | HyperbeeEntry<T>>

• Parameters

  • Optionalrange: ReadStreamRange
  • Optionaloptions: ReadStreamOptions

  Returns Promise<null | HyperbeeEntry<T>>

put

• put(key, value?, options?): Promise<void>

• Parameters

  • key: string
  • Optionalvalue: any
  • Optionaloptions: PutOptions<T>

  Returns Promise<void>

ready

• ready(): Promise<void>

• Returns Promise<void>

replicate

• replicate(isInitiatorOrStream): Readable<any, any, any, true, false, ReadableEvents<any>>

• Parameters

  • isInitiatorOrStream: any

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

snapshot

• snapshot(): Hyperbee<any>

• Returns Hyperbee<any>

sub

• sub(prefix, options?): Hyperbee<any>

• Parameters

  • prefix: string
  • Optionaloptions: SubDatabaseOptions

  Returns Hyperbee<any>

watch

• watch(range?): AsyncIterable<[any, any], any, any> & {
      close: (() => Promise<void>);
  }

• Parameters

  • Optionalrange: ReadStreamRange

  Returns AsyncIterable<[any, any], any, any> & {
      close: (() => Promise<void>);
  }

StaticisHyperbee

• isHyperbee(core, options?): Promise<boolean>

• Parameters

  • core: Hypercore<"binary", undefined>
  • Optionaloptions: any

  Returns Promise<boolean>