Backstage
    Preparing search index...

    Function getOctokitClient

    • Helper for generating an authenticated Octokit client with (or without) retry capabilities.

      If retries are enabled (default), the client will retry failed requests up to the specified number of retries and delay. To disable retries, set either retries or retryAfter to 0 in the options.

      Parameters

      • octokitOptions: OctokitOptions

        The options for configuring the Octokit client. Generally provided by the getOctokitOptions helper.

      • logger: LoggerService

        LoggerService instance for logging retry attempts and failures.

      • OptionalretryOptions: RetryOptions

        Optional retry configuration options, including the number of retries and the delay between retries.

      Returns Octokit & { paginate: PaginateInterface } & {
          graphql: graphql & {
              paginate: <ResponseType_1 extends object = any>(
                  query: string,
                  initialParameters?: Record<string, any>,
              ) => Promise<ResponseType_1> & {
                  iterator: <ResponseType_2 = any>(
                      query: string,
                      initialParameters?: Record<string, any>,
                  ) => { "[asyncIterator]": () => { next(): Promise<(...)> } };
              };
          };
      } & Api & {
          retry: {
              retryRequest: (
                  error: RequestError,
                  retries: number,
                  retryAfter: number,
              ) => RequestError;
          };
      }

      An authenticated Octokit client instance based on the provided options.

    Settings

    Member Visibility