Edit

Bzz FS API

Installation

npm install @erebos/bzz-fs

Usage

import { BzzFS } from '@erebos/bzz-fs'
import { BzzNode } from '@erebos/bzz-node'

const bzz = new BzzNode({ url: 'http://localhost:8500' })
const bzzFS = new BzzFS({ bzz })

BzzFSConfig

interface BzzFSConfig {
  basePath?: string
  bzz: BzzNode | string
}

BzzFS class

new BzzFS()

Arguments

1. config: BzzFSConfig, see below

Configuration

• basePath?: string: the base path to resolve relative paths to
• bzz: BzzNode | string: the BzzNode instance or gateway URL

.downloadTarTo()

Arguments

1. hashOrDomain: string: ENS name or Swarm hash
2. path: string: tar file path
3. options?: DownloadOptions = {}

Returns Promise<void>

.downloadFileTo()

Arguments

1. hashOrDomain: string: ENS name or Swarm hash
2. path: string
3. options?: DownloadOptions = {}

Returns Promise<void>

.downloadDirectoryTo()

Arguments

1. hashOrDomain: string: ENS name or Swarm hash
2. path: string
3. options?: DownloadOptions = {}

Returns Promise<number> the number of files written.

.downloadTo()

Call downloadFileTo() or downloadDirectoryTo() depending on the provided path.

Arguments

1. hashOrDomain: string: ENS name or Swarm hash
2. path: string
3. options?: DownloadOptions = {}

Returns Promise<void>

.uploadTar()

Arguments

1. path: string: path to an existing tar archive or a directory to pack
2. options?: UploadOptions = {}

Returns Promise<string>

.uploadFileFrom()

Arguments

1. path: string: file to upload
2. options?: UploadOptions = {}

Returns Promise<string>

.uploadDirectoryFrom()

Arguments

1. path: string: directory to upload
2. options?: UploadOptions = {}

Returns Promise<string>

.uploadFrom()

Calls uploadFileFrom() or uploadDirectoryFrom() depending on the provided path.

Arguments

1. path: string: file or directory to upload
2. options?: UploadOptions = {}

Returns Promise<string>