Interface BrowseParams

Query parameters accepted by the browse endpoint.

interface BrowseParams {
    at?: string;
    blame?: boolean;
    limit?: number;
    noContent?: boolean;
    start?: number;
    type?: boolean;
}

Hierarchy (View Summary)

Properties

at? blame? limit? noContent? start? type?

Properties

Optionalat

at?: string

Branch, tag, or commit SHA to browse at

Optionalblame

blame?: boolean

If true, return blame information alongside file content

Optionallimit

limit?: number

Maximum number of results to return per page. Bitbucket default is 25, maximum is 1000.

OptionalnoContent

noContent?: boolean

If true, suppress file content in the response

Optionalstart

start?: number

0-based index of the first result to return. Use nextPageStart from the previous response to paginate forward.

Optionaltype

type?: boolean

If true, only the node type is returned without children

Settings

Member Visibility

On This Page

Properties