Class FileSystem

Hierarchy

FileSystem

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileSystem(__namedParameters: <internal>.ConstructorParams): FileSystem

- Defined in fs/filesystem.ts:84
Parameters
- __namedParameters: <internal>.ConstructorParams
Returns FileSystem

Properties

_publishWhenOnline

_publishWhenOnline: [CID, string][]

_publishing

_publishing: false | [CID, true]

appPath

appPath: undefined | AppPath

Readonly localOnly

localOnly: boolean

proofs

proofs: {}

Type declaration

[_: string]: string

publishHooks

publishHooks: PublishHook[]

root

root: <internal>.default

Methods

acceptShare

acceptShare(__namedParameters: { shareId: string; sharedBy: string }): Promise<FileSystem>

- Defined in fs/filesystem.ts:459
Accept a share. Copies the links to the items into your 'Shared with me' directory. eg. private/Shared with me/Sharer/

Parameters
- __namedParameters: { shareId: string; sharedBy: string }
  - shareId: string
  - sharedBy: string
Returns Promise<FileSystem>

add

add(path: DistinctivePath, content: FileContent | SoftLink | SoftLink[] | Record<string, SoftLink>, options?: MutationOptions): Promise<FileSystem>

- Defined in fs/filesystem.ts:232
Parameters
- path: DistinctivePath
- content: FileContent | SoftLink | SoftLink[] | Record<string, SoftLink>
- options: MutationOptions = {}
Returns Promise<FileSystem>

addPublicExchangeKey

addPublicExchangeKey(): Promise<void>

- Defined in fs/filesystem.ts:588
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>

cat

cat(path: FilePath): Promise<FileContent>

- Defined in fs/filesystem.ts:282
Parameters
- path: FilePath
Returns Promise<FileContent>

deactivate

deactivate(): void

- Defined in fs/filesystem.ts:189
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

exists

exists(path: DistinctivePath): Promise<boolean>

- Defined in fs/filesystem.ts:305
Parameters
- path: DistinctivePath
Returns Promise<boolean>

get

get(path: DistinctivePath): Promise<null | Tree | File>

- Defined in fs/filesystem.ts:313
Parameters
- path: DistinctivePath
Returns Promise<null | Tree | File>

hasPublicExchangeKey

hasPublicExchangeKey(): Promise<boolean>

- Defined in fs/filesystem.ts:600
Checks if the public exchange key was added in the well-known location. See addPublicExchangeKey() for the exact details.

Returns Promise<boolean>

loadShare

loadShare(__namedParameters: { shareId: string; sharedBy: string }): Promise<<internal>.default>

- Defined in fs/filesystem.ts:473
Loads a share. Returns a "entry index", in other words, a private tree with symlinks (soft links) to the shared items.

Parameters
- __namedParameters: { shareId: string; sharedBy: string }
  - shareId: string
  - sharedBy: string
Returns Promise<<internal>.default>

ls

ls(path: DirectoryPath): Promise<Links>

- Defined in fs/filesystem.ts:201
Parameters
- path: DirectoryPath
Returns Promise<Links>

mkdir

mkdir(path: DirectoryPath, options?: MutationOptions): Promise<FileSystem>

- Defined in fs/filesystem.ts:212
Parameters
- path: DirectoryPath
- options: MutationOptions = {}
Returns Promise<FileSystem>

mv

mv(from: DistinctivePath, to: DistinctivePath): Promise<FileSystem>

- Defined in fs/filesystem.ts:322
Parameters
- from: DistinctivePath
- to: DistinctivePath
Returns Promise<FileSystem>

publish

publish(): Promise<CID>

- Defined in fs/filesystem.ts:437
Ensures the latest version of the file system is added to IPFS, updates your data root, and returns the root CID.

Returns Promise<CID>

read

read(path: FilePath): Promise<null | FileContent>

- Defined in fs/filesystem.ts:291
Parameters
- path: FilePath
Returns Promise<null | FileContent>

resolveSymlink

resolveSymlink(link: SoftLink): Promise<null | Tree | File>

- Defined in fs/filesystem.ts:614
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.

Parameters
- link: SoftLink
Returns Promise<null | Tree | File>

rm

rm(path: DistinctivePath): Promise<FileSystem>

- Defined in fs/filesystem.ts:351
Parameters
- path: DistinctivePath
Returns Promise<FileSystem>

sharePrivate

sharePrivate(paths: DistinctivePath[], __namedParameters: { shareWith: string | string[]; sharedBy?: SharedBy }): Promise<ShareDetails>

- Defined in fs/filesystem.ts:537
Share a private file with a user.

Parameters
- paths: DistinctivePath[]
- __namedParameters: { shareWith: string | string[]; sharedBy?: SharedBy }
  - shareWith: string | string[]
  - Optional sharedBy?: SharedBy
Returns Promise<ShareDetails>

symlink

symlink(args: { at: DirectoryPath; name: string; referringTo: DistinctivePath; username?: string }): Promise<FileSystem>

- Defined in fs/filesystem.ts:366
Make an internal symbolic link at a path.

Parameters
- args: { at: DirectoryPath; name: string; referringTo: DistinctivePath; username?: string }
  - at: DirectoryPath
  - name: string
  - referringTo: DistinctivePath
  - Optional username?: string
Returns Promise<FileSystem>

write

write(path: FilePath, content: FileContent, options?: MutationOptions): Promise<FileSystem>

- Defined in fs/filesystem.ts:296
Parameters
- path: FilePath
- content: FileContent
- options: MutationOptions = {}
Returns Promise<FileSystem>

Static empty

empty(opts?: NewFileSystemOptions): Promise<FileSystem>

- Defined in fs/filesystem.ts:149
Creates a file system with an empty public tree & an empty private tree at the root.

Parameters
- opts: NewFileSystemOptions = {}
Returns Promise<FileSystem>

Static fromCID

fromCID(cid: CID, opts?: FileSystemOptions): Promise<null | FileSystem>

- Defined in fs/filesystem.ts:166
Loads an existing file system from a CID.

Parameters
- cid: CID
- opts: FileSystemOptions = {}
Returns Promise<null | FileSystem>

Generated using TypeDoc