Skip to content

Latest commit

 

History

History
88 lines (54 loc) · 2.06 KB

REPO.md

File metadata and controls

88 lines (54 loc) · 2.06 KB
Raw

Repo API

repo.gc

Perform a garbage collection sweep on the repo.

Go WIP
JavaScript - ipfs.repo.gc([options, callback])

Where:

  • options is an object that contains following properties
    • quiet writes a minimal output.
    • stream-errors stream errors.

callback must follow function (err, res) {} signature, where err is an Error if the operation was not successful.

If no callback is passed, a promise is returned.

Example:

ipfs.repo.gc((err, res) => console.log(res))

repo.stat

Get stats for the currently used repo.

Go WIP
JavaScript - ipfs.repo.stat([options, callback])

stats.repo and repo.stat can be used interchangeably.

Where:

  • options is an object that contains following properties
    • human a Boolean value to output repoSize in MiB.

callback must follow function (err, stats) {} signature, where err is an Error if the operation was not successful and stats is an object containing the following keys:

  • numObjects is a Big Int.
  • repoSize is a Big Int, in bytes.
  • repoPath is a string.
  • version is a string.
  • storageMax is a Big Int.

If no callback is passed, a promise is returned.

Example:

ipfs.repo.stat((err, stats) => console.log(stats))

// { numObjects: 15,
//   repoSize: 64190,
//   repoPath: 'C:\\Users\\henri\\AppData\\Local\\Temp\\ipfs_687c6eb3da07d3b16fe3c63ce17560e9',
//   version: 'fs-repo@6',
//   storageMax: 10000000000 }

repo.version

Show the repo version.

Go WIP
JavaScript - ipfs.repo.version([callback])

callback must follow function (err, version) {} signature, where err is an Error if the operation was not successful and version is a String containing the version.

If no callback is passed, a promise is returned.

Example:

ipfs.repo.version((err, version) => console.log(version))

// "6"