Class Hyperdrive

Hierarchy

TypedEmitter<HyperdriveEvents>
- Hyperdrive

Index

Constructors

Properties

blobs contentKey core db discoveryKey id key version

Methods

batch checkout clear close createReadStream createWriteStream del diff download downloadDiff downloadRange entries entry get getBlobs list mirror put readdir ready update

Constructors

constructor

new Hyperdrive(corestore, key?, opts?): Hyperdrive
Parameters
- corestore: Corestore
- Optionalkey: null | Buffer
- Optionalopts: HyperdriveOptions
Returns Hyperdrive
Overrides TypedEmitter<HyperdriveEvents>.constructor
new Hyperdrive(corestore, opts?): Hyperdrive
Parameters
- corestore: Corestore
- Optionalopts: HyperdriveOptions
Returns Hyperdrive
Overrides TypedEmitter<HyperdriveEvents>.constructor

Properties

`Readonly`blobs

blobs: null | Hyperblobs

`Readonly`contentKey

contentKey: null | Buffer

`Readonly`core

core: Hypercore<"binary", undefined>

`Readonly`db

db: Hyperbee<any>

`Readonly`discoveryKey

discoveryKey: null | Buffer

`Readonly`id

id: null | string

`Readonly`key

key: null | Buffer

`Readonly`version

version: number

Methods

batch

batch(): any
Returns any

checkout

checkout(version): Hyperdrive
Parameters
- version: number
Returns Hyperdrive

clear

clear(path, opts?): Promise<null | {
blocks: number;
}>
Parameters
- path: string
- Optionalopts: {
  diff?: boolean;
  }
  - Optionaldiff?: boolean
Returns Promise<null | {
blocks: number;
}>

close

close(): Promise<void>
Returns Promise<void>

createReadStream

createReadStream(path, opts?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- path: string
- Optionalopts: {
      core?: Hypercore<"binary", undefined>;
      end?: number;
      length?: number;
      start?: number;
  }
  - Optionalcore?: Hypercore<"binary", undefined>
  - Optionalend?: number
  - Optionallength?: number
  - Optionalstart?: number
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

createWriteStream

createWriteStream(path, opts?): Writable<any, any, any, false, true, WritableEvents<any>>
Parameters
- path: string
- Optionalopts: {
  executable?: boolean;
  metadata?: any;
  }
  - Optionalexecutable?: boolean
  - Optionalmetadata?: any
Returns Writable<any, any, any, false, true, WritableEvents<any>>

del

del(path): Promise<void>
Parameters
- path: string
Returns Promise<void>

diff

diff(version, folder, opts?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- version: number
- folder: string
- Optionalopts: any
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

download

download(folder?, opts?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- Optionalfolder: string
- Optionalopts: {
  recursive?: boolean;
  }
  - Optionalrecursive?: boolean
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

downloadDiff

downloadDiff(version, folder, opts?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- version: number
- folder: string
- Optionalopts: any
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

downloadRange

downloadRange(dbRanges, blobRanges): {
destroy: (() => void);
done: Promise<void>;
}
Parameters
- dbRanges: Range
- blobRanges: Range
Returns {
destroy: (() => void);
done: Promise<void>;
}
- destroy: (() => void)
  - - (): void
    - Returns void
- done: Promise<void>

entries

entries(opts): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- opts: any
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

entry

entry(path, opts?): Promise<null | HyperdriveEntry>
Parameters
- path: string
- Optionalopts: HyperdriveGetOpts
Returns Promise<null | HyperdriveEntry>

get

get(path, opts?): Promise<null | Buffer>
Parameters
- path: string
- Optionalopts: {
  follow?: boolean;
  } & HyperdriveGetOpts
Returns Promise<null | Buffer>

getBlobs

getBlobs(): Promise<Hyperblobs>
Returns Promise<Hyperblobs>

list

list(folder, opts?): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- folder: string
- Optionalopts: {
  recursive?: boolean;
  }
  - Optionalrecursive?: boolean
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

mirror

mirror(): any
Returns any

put

put(path, blob, opts?): Promise<void>
Parameters
- path: string
- blob: Buffer
- Optionalopts: {
  executable?: boolean;
  metadata?: any;
  }
  - Optionalexecutable?: boolean
  - Optionalmetadata?: any
Returns Promise<void>

readdir

readdir(folder): Readable<any, any, any, true, false, ReadableEvents<any>>
Parameters
- folder: string
Returns Readable<any, any, any, true, false, ReadableEvents<any>>

ready

ready(): Promise<void>
Returns Promise<void>

update

update(options?): Promise<Boolean>
Parameters
- Optionaloptions: {
  wait?: boolean;
  }
  - Optionalwait?: boolean
Returns Promise<Boolean>