FileSystemRegistry | uristorage

Represents a StorageRegistry that mimics the API of a FileSystemOverlay instance, resolving all path-based operations via URI (my-namespace://path/to/file.txt) parsing. Using the URI protocol as the namespace to lookup, and the URI pathname as the directory / file path

Hierarchy

StorageRegistry<FileSystemOverlay, IFileSystemRegistryNode>
- FileSystemRegistry

Index

Constructors

constructor

Properties

Constructors

constructor

new FileSystemRegistry(): FileSystemRegistry

Inherited from StorageRegistry.constructor
- Defined in src/registries/storage.ts:100
Returns FileSystemRegistry

Properties

EVENT_MOUNTED

EVENT_MOUNTED: IEvent<IRegistryMountEvent<T>> = event<IRegistryMountEvent<T>>()

Event that dispatches whenever a registered IStorage instance is mounted

EVENT_REGISTERED

EVENT_REGISTERED: IEvent<IRegistryRegisterEvent<T>> = event<IRegistryRegisterEvent<T>>()

Event that dispatches whenever a new IStorage instance is registered

EVENT_UNMOUNTED

EVENT_UNMOUNTED: IEvent<IRegistryMountEvent<T>> = event<IRegistryMountEvent<T>>()

Event that dispatches whenever a registered IStorage instance is unmounted

EVENT_UNREGISTERED

EVENT_UNREGISTERED: IEvent<IRegistryRegisterEvent<T>> = event<IRegistryRegisterEvent<T>>()

Event that dispatches whenever a new IStorage instance is unregistered

Readonly size

size: number

Methods

clear

clear(): void

Inherited from StorageRegistry.clear

Overrides ImmutableMap.clear
- Defined in src/registries/storage.ts:119
Returns void

create_directory

create_directory(uri: string): Promise<void>

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

Parameters
- uri: string
Returns Promise<void>

create_url_object

create_url_object(uri: string): Promise<IURLObject>

- Defined in src/registries/file_system.ts:54
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
- uri: string
Returns Promise<IURLObject>

delete

delete(key: string): boolean

Inherited from ImmutableMap.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23
Parameters
- key: string
Returns boolean

entries

entries(): IterableIterator<[string, IFileSystemRegistryNode]>

Inherited from ImmutableMap.entries
- Defined in src/util/map.ts:6
Returns IterableIterator<[string, IFileSystemRegistryNode]>

exists

exists(uri: string): Promise<boolean>

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

Parameters
- uri: string
Returns Promise<boolean>

forEach

forEach(callback: (value: IFileSystemRegistryNode, key: string, map: Map<string, IFileSystemRegistryNode>) => void, thisArg?: any): void

Inherited from ImmutableMap.forEach

Overrides Map.forEach
- Defined in src/util/map.ts:15
Parameters
- callback: (value: IFileSystemRegistryNode, key: string, map: Map<string, IFileSystemRegistryNode>) => void
  - - (value: IFileSystemRegistryNode, key: string, map: Map<string, IFileSystemRegistryNode>): void
    - Parameters
      - value: IFileSystemRegistryNode
      - key: string
      - map: Map<string, IFileSystemRegistryNode>
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): IFileSystemRegistryNode | undefined

Inherited from ImmutableMap.get

Overrides Map.get
- Defined in src/util/map.ts:23
Parameters
- key: string
Returns IFileSystemRegistryNode | undefined

get_stats

get_stats(uri: string): Promise<IFileSystemEntryStats>

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

Parameters
- uri: string
Returns Promise<IFileSystemEntryStats>

has

has(key: string): boolean

Inherited from ImmutableMap.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:26
Parameters
- key: string
Returns boolean

read_directory

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

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

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

read_file

read_file(uri: string): Promise<Uint8Array>

- Defined in src/registries/file_system.ts:130
Returns a Uint8Array a File in the File System

Parameters
- uri: string
Returns Promise<Uint8Array>

read_file_json

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

- Defined in src/registries/file_system.ts:223
Returns parsed JSON read from the given uri

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

read_file_text

read_file_text(uri: string): Promise<string>

- Defined in src/registries/file_system.ts:240
Returns UTF-8 text read from the given uri

Parameters
- uri: string
Returns Promise<string>

register

Inherited from StorageRegistry.register
- Defined in src/registries/storage.ts:135
Registers an BaseAdapter or BaseOverlay instance with the Registry

Parameters
- namespace: string
- storage: FileSystemOverlay
Returns this | Promise<this>

remove_directory

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

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

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

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

remove_file

remove_file(uri: string): Promise<void>

- Defined in src/registries/file_system.ts:162
Removes a File from the File System

Parameters
- uri: string
Returns Promise<void>

resolve

resolve(uri: string | URL): (IFileSystemRegistryNode & IRegistryResolveResult) | null

Inherited from StorageRegistry.resolve
- Defined in src/registries/storage.ts:178
Returns the resolved namespace and path of a registered BaseAdapter or BaseOverlay instance, returning null if none found or the URI could not be parsed

Parameters
- uri: string | URL
Returns (IFileSystemRegistryNode & IRegistryResolveResult) | null

set

set(key: string, value: IFileSystemRegistryNode): this

Inherited from ImmutableMap.set

Overrides Map.set
- Defined in src/util/map.ts:29
Parameters
- key: string
- value: IFileSystemRegistryNode
Returns this

unregister

unregister(namespace: string): this | Promise<this>

Inherited from StorageRegistry.unregister
- Defined in src/registries/storage.ts:160
Unregisters a previously BaseAdapter or BaseOverlay instance from the Registry

Parameters
- namespace: string
Returns this | Promise<this>

values

values(): IterableIterator<IFileSystemRegistryNode>

Inherited from ImmutableMap.values
- Defined in src/util/map.ts:36
Returns IterableIterator<IFileSystemRegistryNode>

watch_directory

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

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

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

watch_file

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

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

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

write_file

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

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

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

write_file_json

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

- Defined in src/registries/file_system.ts:257
Writes to the given uri, encoding value as JSON text

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

write_file_text

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

- Defined in src/registries/file_system.ts:277
Writes to the given uri, encoding text as UTF-8 bytes

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

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FileSystemRegistry

Properties

EVENT_MOUNTED

EVENT_REGISTERED

EVENT_UNMOUNTED

EVENT_UNREGISTERED

Readonly size

Methods

clear

Returns void

create_directory

Parameters

uri: string

Returns Promise<void>

create_url_object

Parameters

uri: string

Returns Promise<IURLObject>

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, IFileSystemRegistryNode]>

exists

Parameters

uri: string

Returns Promise<boolean>

forEach

Parameters

callback: (value: IFileSystemRegistryNode, key: string, map: Map<string, IFileSystemRegistryNode>) => void

Parameters

value: IFileSystemRegistryNode

key: string

map: Map<string, IFileSystemRegistryNode>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: string

Returns IFileSystemRegistryNode | undefined

get_stats

Parameters

uri: string

Returns Promise<IFileSystemEntryStats>

has

Parameters

key: string

Returns boolean

read_directory

Parameters

namespace: string

Default value options: IFileSystemQueryOptions = {}

Returns Promise<IFileSystemEntryResult[]>

read_file

Parameters

uri: string

Returns Promise<Uint8Array>

read_file_json

Type parameters

T: IJSONValue = IJSONValue

Parameters

uri: string

Optional reviver: IJSONReviver

Returns Promise<T>

read_file_text

Parameters

uri: string

Returns Promise<string>

register

Parameters

namespace: string