FileSystemOverlay | uristorage

Represents a URIStorage Overlay that treats the configured Adapter as a psuedo File System

Hierarchy

BaseOverlay
- FileSystemOverlay

Index

Constructors

constructor

Properties

Constructors

constructor

new FileSystemOverlay(adapter: BaseAdapter, options?: Partial<IFileSystemOptions>): FileSystemOverlay

Overrides BaseOverlay.constructor
- Defined in src/overlays/file_system.ts:252
Parameters
- adapter: BaseAdapter
- Default value options: Partial<IFileSystemOptions> = {}
Returns FileSystemOverlay

Properties

EVENT_MOUNTED

EVENT_MOUNTED: IEvent<IMountedEvent> = event<IMountedEvent>()

Event that dispatches whenever the Adapter is mounted

EVENT_UNMOUNTED

EVENT_UNMOUNTED: IEvent<IMountedEvent> = event<IMountedEvent>()

Event that dispatches whenever the Adapter is unmounted

adapter

adapter: BaseAdapter

Represents the Adapter configured to be overlaid

options

options: IFileSystemOptions

Represents the standardized options passed into the constructor

Methods

create_directory

create_directory(directory_path: string): Promise<void>

- Defined in src/overlays/file_system.ts:305
Creates a new Directory in the File System

Parameters
- directory_path: string
Returns Promise<void>

create_scope

create_scope(path: string): FileSystemOverlay

- Defined in src/overlays/file_system.ts:265
Returns a new FileSystemOverlay instance scoped to the given path

Parameters
- path: string
Returns FileSystemOverlay

create_url_object

create_url_object(file_path: string): Promise<IURLObject>

- Defined in src/overlays/file_system.ts:280
Returns a embedable URL representing a File in the File System

NOTE: Will not work with if the configured Adapter's BaseAdapter.can_hotlink is false

Parameters
- file_path: string
Returns Promise<IURLObject>

exists

exists(path: string): Promise<boolean>

- Defined in src/overlays/file_system.ts:358
Returns if a given Entry exists on the File System

Parameters
- path: string
Returns Promise<boolean>

get_stats

get_stats(path: string): Promise<IFileSystemEntryStats>

- Defined in src/overlays/file_system.ts:369
Returns the File System metadata about a given Entry

Parameters
- path: string
Returns Promise<IFileSystemEntryStats>

has_feature

has_feature(feature: string): boolean

Inherited from BaseOverlay.has_feature
- Defined in src/overlays/base_overlay.ts:49
Returns if the currently assigned feature flag is enabled on the configured adapter

Parameters
- feature: string
Returns boolean

is_mounted

is_mounted(): boolean

Inherited from BaseOverlay.is_mounted
- Defined in src/overlays/base_overlay.ts:62
Returns if the Overlay is currently mounted

NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

Returns boolean

mount

mount(): Promise<void>

Inherited from BaseOverlay.mount
- Defined in src/overlays/base_overlay.ts:72
Mounts the Overlay if currently unmounted

NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

Returns Promise<void>

read_directory

read_directory(options?: IFileSystemQueryOptions): Promise<IFileSystemEntryResult[]>

- Defined in src/overlays/file_system.ts:390
Returns entries queried from the File System, with optional filters

Parameters
- Default value options: IFileSystemQueryOptions = {}
Returns Promise<IFileSystemEntryResult[]>

read_file

read_file(file_path: string): Promise<Uint8Array>

- Defined in src/overlays/file_system.ts:467
Returns a Uint8Array a File in the File System

Parameters
- file_path: string
Returns Promise<Uint8Array>

read_file_json

read_file_json<T>(file_path: string, reviver?: IJSONReviver): Promise<T>

- Defined in src/overlays/file_system.ts:738
Returns parsed JSON read from the given file_path

Type parameters
- T: IJSONValue = IJSONValue
Parameters
- file_path: string
- Optional reviver: IJSONReviver
Returns Promise<T>

read_file_text

read_file_text(file_path: string): Promise<string>

- Defined in src/overlays/file_system.ts:751
Returns UTF-8 text read from the given file_path

Parameters
- file_path: string
Returns Promise<string>

remove_directory

remove_directory(directory_path: string, options?: IFileSystemRemoveOptions): Promise<boolean>

- Defined in src/overlays/file_system.ts:490
Removes a Directory from the File System

NOTE: If IFileSystemRemoveOptions.recursive to false, the dispatch will fail if sub-paths are found

Parameters
- directory_path: string
- Default value options: IFileSystemRemoveOptions = {}
Returns Promise<boolean>

remove_file

remove_file(file_path: string): Promise<void>

- Defined in src/overlays/file_system.ts:550
Removes a File from the File System

Parameters
- file_path: string
Returns Promise<void>

unmount

unmount(): Promise<void>

Inherited from BaseOverlay.unmount
- Defined in src/overlays/base_overlay.ts:82
Unmounts the Overlay if currently mounted

NOTE: There is no base concept of "mounting", it could be establishing a connection to a FTP server, mounting a local SQLite3 database, etc, etc

Returns Promise<void>

watch_directory

watch_directory(directory_path: string, options?: IFileSystemWatchOptions): Promise<IEvent<IFileSystemWatchEvent>>

- Defined in src/overlays/file_system.ts:577
Watches a Directory for any changes on the File System

Parameters
- directory_path: string
- Default value options: IFileSystemWatchOptions = {}
Returns Promise<IEvent<IFileSystemWatchEvent>>

watch_file

watch_file(file_path: string): Promise<IEvent<IFileSystemWatchEvent>>

- Defined in src/overlays/file_system.ts:650
Watches a File for any changes on the File System

Parameters
- file_path: string
Returns Promise<IEvent<IFileSystemWatchEvent>>

write_file

write_file(file_path: string, payload: Uint8Array): Promise<void>

- Defined in src/overlays/file_system.ts:703
Writes a Uint8Array payload to a File. Creating a new File in the File System, if not previously made

Parameters
- file_path: string
- payload: Uint8Array
Returns Promise<void>

write_file_json

write_file_json<T>(file_path: string, value: T, replacer?: IJSONReplacer, space?: number | string): Promise<void>

- Defined in src/overlays/file_system.ts:764
Writes to the given file_path, encoding value as JSON text

Type parameters
- T: IJSONValue = IJSONValue
Parameters
- file_path: string
- value: T
- Optional replacer: IJSONReplacer
- Optional space: number | string
Returns Promise<void>

write_file_text

write_file_text(file_path: string, text: string): Promise<void>

- Defined in src/overlays/file_system.ts:780
Writes to the given file_path, encoding text as UTF-8 bytes

Parameters
- file_path: string
- text: string
Returns Promise<void>

Generated using TypeDoc