RemoteBrowser
Defined in: src/sync/createRemoteBrowser.ts:58
Stateful directory browser returned by createRemoteBrowser.
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
entries | readonly | readonly RemoteEntry[] | Last loaded sorted/filtered entries. | src/sync/createRemoteBrowser.ts:62 |
path | readonly | string | Current absolute path. | src/sync/createRemoteBrowser.ts:60 |
Methods
Section titled “Methods”breadcrumbs()
Section titled “breadcrumbs()”breadcrumbs(): RemoteBreadcrumb[];Defined in: src/sync/createRemoteBrowser.ts:72
Compute breadcrumbs for the current path without re-listing.
Returns
Section titled “Returns”navigate()
Section titled “navigate()”navigate(target: string): Promise<RemoteBrowserSnapshot>;Defined in: src/sync/createRemoteBrowser.ts:66
Navigate to the supplied absolute or relative path.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
target | string |
Returns
Section titled “Returns”Promise<RemoteBrowserSnapshot>
open()
Section titled “open()”open(entry: RemoteEntry): Promise<RemoteBrowserSnapshot>;Defined in: src/sync/createRemoteBrowser.ts:68
Descend into the supplied directory entry. Throws when the entry is not a directory.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entry | RemoteEntry |
Returns
Section titled “Returns”Promise<RemoteBrowserSnapshot>
refresh()
Section titled “refresh()”refresh(): Promise<RemoteBrowserSnapshot>;Defined in: src/sync/createRemoteBrowser.ts:64
Reload the current directory and return the latest snapshot.
Returns
Section titled “Returns”Promise<RemoteBrowserSnapshot>
setShowHidden()
Section titled “setShowHidden()”setShowHidden(showHidden: boolean): void;Defined in: src/sync/createRemoteBrowser.ts:76
Toggle hidden-entry visibility. The next refresh re-applies the filter.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
showHidden | boolean |
Returns
Section titled “Returns”void
setSort()
Section titled “setSort()”setSort(key: RemoteEntrySortKey, order?: RemoteEntrySortOrder): void;Defined in: src/sync/createRemoteBrowser.ts:74
Update the sort key. The next refresh re-sorts the cached entries.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | RemoteEntrySortKey |
order? | RemoteEntrySortOrder |
Returns
Section titled “Returns”void
up(): Promise<RemoteBrowserSnapshot>;Defined in: src/sync/createRemoteBrowser.ts:70
Move to the parent directory; no-op when already at the root.
Returns
Section titled “Returns”Promise<RemoteBrowserSnapshot>