Class Corestore

constructor

• new Corestore(storage, options?): Corestore

• Parameters

  • storage: HypercoreStorage
  • Optionaloptions: {
        poolSize?: number;
        primaryKey?: Uint8Array | Buffer;
    }

    • OptionalpoolSize?: number

    • OptionalprimaryKey?: Uint8Array | Buffer

  Returns Corestore

cores

close

• close(): Promise<void>

• Returns Promise<void>

get

• get(key): Hypercore<ValueEncoding, Buffer>

• Parameters

  • key: Uint8Array | Buffer

  Returns Hypercore<ValueEncoding, Buffer>

• get(options): Hypercore<ValueEncoding, Buffer>

• Parameters

  • options: Omit<HypercoreOptions<"binary", undefined>, "keyPair"> & {
        name: string;
    }

  Returns Hypercore<ValueEncoding, Buffer>

• get(options): Hypercore<ValueEncoding, Buffer>

• Parameters

  • options: never

  Returns Hypercore<ValueEncoding, Buffer>

• get(options): Hypercore<ValueEncoding, Buffer>

• Parameters

  • options: Omit<HypercoreOptions<"binary", undefined>, "key" | "keyPair"> & {
        key?: string | Buffer;
        keyPair: {
            publicKey: Buffer;
            secretKey?: null | Buffer;
        };
        sparse?: boolean;
    }

  Returns Hypercore<ValueEncoding, Buffer>

namespace

• namespace(name): Corestore

• Parameters

  • name: string

  Returns Corestore

ready

• ready(): Promise<void>

• Returns Promise<void>

replicate

• replicate(stream, opts?): ReplicationStream

• Parameters

  • stream: any
  • Optionalopts: any

  Returns ReplicationStream