Class CoreIndex

An in-memory index of open cores.

Index

Constructors

Methods

[iterator] add getByCoreKey getByDiscoveryId getByNamespace getWriter

Constructors

constructor

new CoreIndex(): CoreIndex
Returns CoreIndex

Methods

[iterator]

[iterator](): IterableIterator<CoreRecord>
Returns IterableIterator<CoreRecord>

add

add(options): void
NB. Need to pass key here because core.key is not populated until the core is ready, but we know it beforehand.
Parameters
- options: {
      core: Hypercore<"binary", Buffer>;
      key: Buffer;
      namespace:
          | "blob"
          | "auth"
          | "config"
          | "data"
          | "blobIndex";
      writer: undefined | boolean;
  }
  - core: Hypercore<"binary", Buffer>
    Hypercore instance
  - key: Buffer
    Buffer containing public key of this core
  - namespace:
        | "blob"
        | "auth"
        | "config"
        | "data"
        | "blobIndex"
  - writer: undefined | boolean
    Is this a writer core?
Returns void

getByCoreKey

getByCoreKey(coreKey): undefined | CoreRecord
Get a core by its public key
Parameters
- coreKey: Buffer
Returns undefined | CoreRecord

getByDiscoveryId

getByDiscoveryId(discoveryId): undefined | CoreRecord
Get a core by its discoveryId (discover key as hex string)
Parameters
- discoveryId: string
Returns undefined | CoreRecord

getByNamespace

getByNamespace(namespace): CoreRecord[]
Get all known cores in a namespace
Parameters
- namespace:
      | "blob"
      | "auth"
      | "config"
      | "data"
      | "blobIndex"
Returns CoreRecord[]

getWriter

getWriter(namespace): CoreRecord
Get the write core for the given namespace
Parameters
- namespace:
      | "blob"
      | "auth"
      | "config"
      | "data"
      | "blobIndex"
Returns CoreRecord