import Filesystem from '@osjs/client/src/filesystem.js'

public class | source

Filesystem

Extends:

@osjs/event-emitter~EventEmitter → Filesystem

Filesystem Class that manages filesystems and adapters

Constructor Summary

Public Constructor
public	constructor(core: Core, options: FilesystemOptions) Create filesystem manager

Member Summary

Public Members
public	adapters: {name: FilesystemAdapterWrapper} Adapter registry
public	core: Core Core instance reference
public	mounts: FilesystemMountpoint[] Mountpoints
public	options: FilesystemOptions Options
public	proxy: {key: Function} A wrapper for VFS method requests

Method Summary

Public Methods
public	addMountpoint(props: FilesystemMountpoint, automount: boolean): Promise<boolean> Adds a new mountpoint
public	createMountpoint(props: FilesystemMountpoint): FilesystemMountpoint Creates a new mountpoint based on given properties
public	getMountpointFromPath(file: string \| VFSFile): FilesystemMountpoint \| null Gets mountpoint from given path
public	getMounts(all: boolean): FilesystemMountpoint[] Gets all mountpoints
public	mount(m: string \| FilesystemMountpoint): Promise<boolean> Mount given mountpoint
public	mountAll(stopOnError: boolean): Promise<boolean[]> Mounts all configured mountpoints
public	request(): FilesystemAdapterMethods Gets the proxy for VFS methods FIXME: Not correct type, but works for documentation atm
public	unmount(name: string): Promise<boolean> Unmount given filesystem

Private Methods
private	_getConfiguredMountpoints(): FilesystemMountpoint[] Gets configured mountpoints
private	_mountAction(name: string, unmount: boolean): Promise<boolean> Internal wrapper for mounting/unmounting by name
private	_mountpointAction(mountpoint: FilesystemMountpoint, unmount: boolean): Promise<boolean> Internal wrapper for mounting/unmounting
private	_request(method: string): * Perform a VFS method request
private	_requestAction(method: string): Promise<*> Request action wrapper

Public Constructors

public constructor(core: Core, options: FilesystemOptions) source

Create filesystem manager

Params:

Name	Type	Attribute	Description
core	Core		Core reference
options	FilesystemOptions	optional	Options

Public Members

public adapters: {name: FilesystemAdapterWrapper} source

Adapter registry

public core: Core source

Core instance reference

public mounts: FilesystemMountpoint[] source

Mountpoints

public options: FilesystemOptions source

Options

public proxy: {key: Function} source

A wrapper for VFS method requests

Public Methods

public addMountpoint(props: FilesystemMountpoint, automount: boolean): Promise<boolean> source

Adds a new mountpoint

Params:

Name	Type	Attribute	Description
props	FilesystemMountpoint		Mountpoint props
automount	boolean	optional default: true	Automount after creation

Return:

Promise<boolean>

public createMountpoint(props: FilesystemMountpoint): FilesystemMountpoint source

Creates a new mountpoint based on given properties

Params:

Name	Type	Attribute	Description
props	FilesystemMountpoint		Properties

Return:

FilesystemMountpoint

public getMountpointFromPath(file: string | VFSFile): FilesystemMountpoint | null source

Gets mountpoint from given path

Params:

Name	Type	Attribute	Description
file	string \| VFSFile		The file

Return:

FilesystemMountpoint | null

public getMounts(all: boolean): FilesystemMountpoint[] source

Gets all mountpoints

Params:

Name	Type	Attribute	Description
all	boolean	optional default: false

Return:

FilesystemMountpoint[]

public mount(m: string | FilesystemMountpoint): Promise<boolean> source

Mount given mountpoint

Params:

Name	Type	Attribute	Description
m	string \| FilesystemMountpoint		Mountpoint name or object

Return:

Promise<boolean>

Throw:

Error

On invalid name or if already mounted

public mountAll(stopOnError: boolean): Promise<boolean[]> source

Mounts all configured mountpoints

Params:

Name	Type	Attribute	Description
stopOnError	boolean	optional default: true	Stop on first error

Return:

Promise<boolean[]>

public request(): FilesystemAdapterMethods source

Gets the proxy for VFS methods FIXME: Not correct type, but works for documentation atm

Return:

FilesystemAdapterMethods

A map of VFS functions

public unmount(name: string): Promise<boolean> source

Unmount given filesystem

Params:

Name	Type	Attribute	Description
name	string		Filesystem name

Return:

Promise<boolean>

Throw:

Error

On invalid name or if already unmounted

Private Methods

private _getConfiguredMountpoints(): FilesystemMountpoint[] source

Gets configured mountpoints

Return:

FilesystemMountpoint[]

private _mountAction(name: string, unmount: boolean): Promise<boolean> source

Internal wrapper for mounting/unmounting by name

Params:

Name	Type	Attribute	Description
name	string		Mountpoint name
unmount	boolean	optional default: false	If action is unmounting

Return:

Promise<boolean>

private _mountpointAction(mountpoint: FilesystemMountpoint, unmount: boolean): Promise<boolean> source

Internal wrapper for mounting/unmounting

Params:

Name	Type	Attribute	Description
mountpoint	FilesystemMountpoint		The mountpoint
unmount	boolean	optional default: false	If action is unmounting

Return:

Promise<boolean>

private _request(method: string): * source

Perform a VFS method request

Params:

Name	Type	Attribute	Description
method	string		VFS method name
...args	*		Arguments

Return:

private _requestAction(method: string): Promise<*> source

Request action wrapper

Params:

Name	Type	Attribute	Description
method	string
...args	*		Arguments

Return:

Promise<*>