Interface LocalSyncFolder

A sync folder constrained to the local filesystem.

interface LocalSyncFolder {
    root: string;
    type: "local";
    scan(): AsyncIterable<SyncPath>;
}

Hierarchy (View Summary)

SyncFolder
- LocalSyncFolder

Index

Properties

Methods

Properties

`Readonly`root

root: string

Absolute filesystem path to the local root directory.

`Readonly`type

type: "local"

Discriminant identifying a local folder.

Methods

scan

scan(): AsyncIterable<SyncPath>
Scans the folder and yields files sorted by relative path.

Returns AsyncIterable<SyncPath>
Inherited from SyncFolder.scan
- Defined in sync/types.ts:156