Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@tabcat/orbit-db-fsstore

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tabcat/orbit-db-fsstore

a custom orbit-db store representing a file system

  • 3.1.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

npm (scoped)

orbit-db-fsstore

an orbit-db store representing a file system

This is a custom OrbitDB store (add this store to your OrbitDB instance)

IMPORTANT: The fsstore creates a root directory named '/r' and every path must be built ontop/contained inside of this!

Install

npm install @tabcat/orbit-db-fsstore

FSStore Instance Methods API

check out ./test for more info

.joinPath(path, name)

returns a new path by combining path and name

const newPath = fsstore.joinPath('/r/this/is/a', 'path')
// '/r/this/is/a/path'

.exists(path)

returns a bool, true if path exists and false if not

const exists = fsstore.exists('/r/file1')
// true

.content(path)

returns the content type at path or undefined if path doesn't exist

const json = fsstore.content('/r')
// 'dir'
const json = fsstore.content('/r/file1')
// 'file'

.read(path)

returns the json data written at path or undefined if path doesn't exist

const json = fsstore.read('/r/file1')
// { hello: 'ipfs cid' }

.tree(path)

return an array of all paths located under the path in the store state

const pathTree = fsstore.tree('/r/dir1')
// ['/r/dir1/file2', '/r/dir1/dir2', '/r/dir1/dir2/file2']

.ls(path)

return an array of only paths located inside the path in the store state

const pathLs = fsstore.ls('/r/dir1')
// ['/r/dir1/file2', '/r/dir1/dir2']

.mkdir(path, name)

makes a new directory at joinPath(path, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.mkdir('/r', 'dir1')

.rmdir(path)

removes an existing directory at path returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.rmdir('/r/dir1')

.mvdir(path, dest, name)

moves an existing directory at path to joinPath(dest, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.mvdir('/r/dir1', '/r', 'dir2')

.cpdir(path, dest, name)

copies an existing directory at path to joinPath(dest, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.cpdir('/r/dir1', '/r', 'dir1')

.mk(path, name)

make a new file at joinPath(path, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.mk('/r', 'file1')

.write(path, json)

map json (any JSON-serializable value) to a file path (!!! do not store blob data in orbitdb, ONLY REFERENCES) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.write('/r/file1', { hello: 'ipfs cid' })

.rm(path)

remove an existing file at path returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.rm('/r/file1')

.mv(path, dest, name)

move an existing file at path to joinPath(dest, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.mv('/r/file1', '/r', 'file2')

.cp(path, dest, name)

copy an existing file at path to joinPath(dest, name) returns a Promise that resolves to a String that is the multihash of the entry.

const entryHash = await fsstore.cp('/r/file1', '/r', 'file2')

Keywords

FAQs

Package last updated on 24 Jul 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc