Interface SyncPlan

The plan.

Example

const plan: SyncPlan = await syncPlan_build(index, ['host'], seams);
plan.entries.filter((e: SyncPlanEntry): boolean => e.group === 'add').length;

interface SyncPlan {
    commit: string | null;
    computes: string[];
    entries: SyncPlanEntry[];
    indexed: number;
    label: string;
    source: string;
}

Index

Properties

commit computes entries indexed label source

Properties

`Readonly`commit

commit: string | null

The commit read, when known.

`Readonly`computes

computes: string[]

The compute resources adds are registered on.

`Readonly`entries

entries: SyncPlanEntry[]

Every entry, by group then name.

`Readonly`indexed

indexed: number

How many descriptors the index holds.

`Readonly`label

label: string

The index's short name (chris-plugins @ 8c9a1f6).

`Readonly`source

source: string

The index's source word.

Interface SyncPlan

Example

Index

Properties

Properties

`Readonly`commit

`Readonly`computes

`Readonly`entries

`Readonly`indexed

`Readonly`label

`Readonly`source

Settings

On This Page

Interface SyncPlan

Example

Index

Properties

Properties

Readonlycommit

Readonlycomputes

Readonlyentries

Readonlyindexed

Readonlylabel

Readonlysource

Settings

On This Page

`Readonly`commit

`Readonly`computes

`Readonly`entries

`Readonly`indexed

`Readonly`label

`Readonly`source