Class HideAction

constructor

• new HideAction(
      relativePath: string,
      doHide: (relativePath: string, signal?: AbortSignal) => Promise<void>,
  ): HideAction

  Creates a new HideAction for the given relative path.

  Parameters

  • relativePath: string

    Path relative to the sync root.

  • doHide: (relativePath: string, signal?: AbortSignal) => Promise<void>

    Callback that creates the hide marker.

  Returns HideAction

ReadonlyrelativePath

Readonlysize

Readonlytype

execute

• execute(dryRun: boolean, signal?: AbortSignal): Promise<SyncEvent>

  Hides the file (unless dryRun) and returns a 'hide' event.

  Parameters

  • dryRun: boolean

    Whether to simulate the action without making changes.

  • Optionalsignal: AbortSignal

    Optional abort signal for canceling the hide request.

  Returns Promise<SyncEvent>

  A promise resolving to the sync event produced by the action.