Interface ForEachRefOptions

ForEachRefOptions defines the supported options for the Git for-each-ref command.

Hierarchy

  • ForEachRefOptions

Properties

--contains? --count? --format? --ignore-case? --merged? --no-contains? --no-merged? --points-at? --sort?

Properties

Optional --contains

--contains?: null | string | string[]

Lists refs which contain the specified commit; HEAD if not specified. See also --no-contains.

Optional --count

--count?: string | number

Limits the number of refs returned.

Optional --format

--format?: string

Interpolates %(fieldname) from a ref being shown and the object it points at.

Optional --ignore-case

--ignore-case?: null

Makes sorting and filtering refs case insensitive.

Optional --merged

--merged?: null | string | string[]

Lists refs whose commits are reachable from the specified commit; HEAD if not specified. See also --no-merged.

Optional --no-contains

--no-contains?: null | string | string[]

Lists refs which don't contain the specified commit; HEAD if not specified. See also --contains.

Optional --no-merged

--no-merged?: null | string | string[]

Lists refs whose commits are not reachable from the specified commit; HEAD if not specified. See also --merged.

Optional --points-at

--points-at?: null | string

Lists refs of the given object.

Optional --sort

--sort?: string | string[]

Sorts based on the given keys.

Settings

Member Visibility

Theme

On This Page