Interface FindAndReplaceInAllRepositoriesOptions

Hierarchy

  • Omit<FindAndReplaceInGithubFileOptions, "repo">
    • FindAndReplaceInAllRepositoriesOptions

Properties

commitMessage delayInMs? octokit onError? owner path regex replacement

Properties

commitMessage

commitMessage: string

The commit message for the changes.

Optional delayInMs

delayInMs?: number

Delay in milliseconds between requests to the GitHub API.

octokit

octokit: Octokit & {
    paginate: PaginateInterface;
} & RestEndpointMethods & Api

Octokit instance for interacting with the GitHub API

Type declaration

  • paginate: PaginateInterface

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Callback function for handling errors.

      Parameters

      • error: Error

      Returns void

owner

owner: string

Owner of the GitHub repositories

path

path: string

The file path in the repository to find and replace text in.

regex

regex: RegExp

The regular expression used to find the text to be replaced.

replacement

replacement: string

The text that will replace the text found using the regex.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc