Class FairosProvider

FairosProvider is the provider for the FairOS provider.

Hierarchy

FdpConnectProvider
- FairosProvider

Index

Constructors

Properties

filesystemDriver mount onMount

Methods

getCurrentMount getFSHandler initialize listMounts podClose podOpen userLoggedIn userLogin

Constructors

constructor

new FairosProvider(host?: string): FairosProvider
Parameters
- host: string = 'https://fairos.dev.fairdatasociety.org/'
Returns FairosProvider
Overrides FdpConnectProvider.constructor
- Defined in providers/fairos.ts:156

Properties

filesystemDriver

filesystemDriver: ProviderDriver

mount

mount: Mount

onMount

onMount: Subject<Mount> = ...

Methods

getCurrentMount

getCurrentMount(): Mount
Get the current mount point.

Returns
Current mount point

Returns Mount
Inherited from FdpConnectProvider.getCurrentMount
- Defined in core/provider.ts:37

getFSHandler

getFSHandler(mount: Mount): Promise<FileSystemDirectoryHandle>
getFSHandler returns a FileSystemDirectoryHandle for the given provider.

Returns
a FileSystemDirectoryHandle
Parameters
- mount: Mount
  
  mount point
Returns Promise<FileSystemDirectoryHandle>
Inherited from FdpConnectProvider.getFSHandler
- Defined in core/provider.ts:46

initialize

initialize(options: any): void
Initialize the provider
Parameters
- options: any
  
  options
Returns void
Overrides FdpConnectProvider.initialize
- Defined in providers/fairos.ts:166

listMounts

listMounts(): Promise<Mount[]>
Returns Promise<Mount[]>
- Defined in providers/fairos.ts:220

podClose

podClose(mount: Mount): Promise<void>
Parameters
- mount: Mount
Returns Promise<void>
- Defined in providers/fairos.ts:258

podOpen

podOpen(mount: Mount): Promise<void>
Parameters
- mount: Mount
Returns Promise<void>
- Defined in providers/fairos.ts:243

userLoggedIn

userLoggedIn(username: string): Promise<any>
Verify if a user is logged in

Returns
Returns a promise with the response
Parameters
- username: string
  
  username
Returns Promise<any>
- Defined in providers/fairos.ts:206

userLogin

userLogin(user: string, pass: string): Promise<any>
Login a user

Returns
Returns a promise with the response
Parameters
- user: string
  
  username
- pass: string
  
  password
Returns Promise<any>
- Defined in providers/fairos.ts:184

Generated using TypeDoc