• Public
  • Public/Protected
  • All


  • FileSystem




_publishWhenOnline: [CID, string][]
_publishing: false | [CID, true]
appPath: undefined | AppPath
localOnly: boolean
proofs: {}

Type declaration

  • [_: string]: string
publishHooks: PublishHook[]


  • acceptShare(__namedParameters: { shareId: string; sharedBy: string }): Promise<FileSystem>
  • Accept a share. Copies the links to the items into your 'Shared with me' directory. eg. private/Shared with me/Sharer/


    • __namedParameters: { shareId: string; sharedBy: string }
      • shareId: string
      • sharedBy: string

    Returns Promise<FileSystem>

  • addPublicExchangeKey(): Promise<void>
  • Stores the public part of the exchange key in the DID format, in the /public/.well-known/exchange/DID_GOES_HERE/ directory.

    Returns Promise<void>

  • deactivate(): void
  • Deactivate a file system.

    Use this when a user signs out. The only function of this is to stop listing to online/offline events.

    Returns void

  • hasPublicExchangeKey(): Promise<boolean>
  • Checks if the public exchange key was added in the well-known location. See addPublicExchangeKey() for the exact details.

    Returns Promise<boolean>

  • loadShare(__namedParameters: { shareId: string; sharedBy: string }): Promise<<internal>.default>
  • Loads a share. Returns a "entry index", in other words, a private tree with symlinks (soft links) to the shared items.


    • __namedParameters: { shareId: string; sharedBy: string }
      • shareId: string
      • sharedBy: string

    Returns Promise<<internal>.default>

  • publish(): Promise<CID>
  • Ensures the latest version of the file system is added to IPFS, updates your data root, and returns the root CID.

    Returns Promise<CID>

  • Resolve a symlink directly. The get and cat methods will automatically resolve symlinks, but sometimes when working with symlinks directly you might want to use this method instead.


    Returns Promise<null | Tree | File>

Generated using TypeDoc