Type Alias ListPullRequestCreatorsData

ListPullRequestCreatorsData: {
    path: { owner: string; repo: string };
    query?: {
        exclude_bots?: boolean;
        page?: number;
        page_size?: number;
        sort?:
            | "login"
            | "prs"
            | "prs-desc"
            | "first_pr_opened_at"
            | "first_pr_opened_at-desc"
            | "first_pr_merged_at"
            | "first_pr_merged_at-desc";
    };
}

Type declaration

  • path: { owner: string; repo: string }
    • owner: string

      The owner of the repo.

    • repo: string

      The name of the repo.

  • Optionalquery?: {
        exclude_bots?: boolean;
        page?: number;
        page_size?: number;
        sort?:
            | "login"
            | "prs"
            | "prs-desc"
            | "first_pr_opened_at"
            | "first_pr_opened_at-desc"
            | "first_pr_merged_at"
            | "first_pr_merged_at-desc";
    }
    • Optionalexclude_bots?: boolean

      Whether to exclude robot accounts (includes GitHub App and normal users whose username matches the pattern, for example: ti-chi-bot).

    • Optionalpage?: number

      Page number of the results to fetch.

    • Optionalpage_size?: number

      The number of results per page (max 100).

    • Optionalsort?:
          | "login"
          | "prs"
          | "prs-desc"
          | "first_pr_opened_at"
          | "first_pr_opened_at-desc"
          | "first_pr_merged_at"
          | "first_pr_merged_at-desc"

      Specify the field by which to sort the pull request creators list (values with a -desc suffix indicate descending sorting)