Interface SearchCodeParams

Query parameters for searching code.

See

https://docs.github.com/en/rest/search/search#search-code

interface SearchCodeParams {
    order?: "asc" | "desc";
    page?: number;
    per_page?: number;
    q: string;
    sort?: "indexed";
}

Hierarchy (View Summary)

Properties

order? page? per_page? q sort?

Properties

Optionalorder

order?: "asc" | "desc"

Sort direction

Optionalpage

page?: number

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

Optionalper_page

per_page?: number

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

q

q: string

The search query string. Required. Supports qualifiers like repo:, path:, language:, extension:.

Optionalsort

sort?: "indexed"

Sort field (only 'indexed' is supported)

Settings

Member Visibility

On This Page

Properties