Function restore

restore(
    this: useGit API,
    paths?: string | string[],
    opts?: RestoreOptions,
): Promise<useGit API>

Restore working tree files.

Parameters

this: useGit API
paths: string | string[] = "."
Default
```
"."
```
opts: RestoreOptions = {}

Returns Promise<useGit API>

Example

// Restore file from index
await git.restore("file.txt")

// Restore all files
await git.restore(".")

// Restore staged file
await git.restore("file.txt", { flags: ["--staged"] })

// Restore from a commit
await git.restore("file.txt", { "--source": "HEAD~1" })

// Restore both index and working tree
await git.restore("file.txt", {
  flags: ["--staged", "--worktree"],
  "--source": "HEAD~1",
})

Since

0.3.0