Interface CommitsParams

Query parameters for listing repository commits.

See

https://docs.github.com/en/rest/commits/commits#list-commits

interface CommitsParams {
    author?: string;
    committer?: string;
    page?: number;
    path?: string;
    per_page?: number;
    sha?: string;
    since?: string;
    until?: string;
}

Hierarchy (View Summary)

Properties

author? committer? page? path? per_page? sha? since? until?

Properties

Optionalauthor

author?: string

Filter by author login or email

Optionalcommitter

committer?: string

Filter by committer login or email

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalpath

path?: string

Only commits containing this file path

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalsha

sha?: string

SHA or branch to start listing commits from

Optionalsince

since?: string

Only commits after this ISO 8601 date

Optionaluntil

until?: string

Only commits before this ISO 8601 date

Settings

Member Visibility

On This Page

Properties