Function getRefs

getRefs<T>(guard, columns, repositoryPath, gitOptions, pattern?, columnDelimiter?): Promise<T[]>
Returns information about Git refs in application-defined JavaScript objects. The JavaScript objects are created from the return of the GitAnnexAPI.forEachRef method.
Type Parameters
- T
  
  The application-defined type of the returned objects.
Parameters
- guard: ((o) => o is T)
  
  The type predicate to validate each ref.
  - - (o): o is T
    - Parameters
      
      o: unknown
      
      Returns o is T
- columns: [string, Parser?][]
  
  Maps the columns returned by gitOptions.ForEachRefOptions.--format to property names. A parser to convert the string to another data type may be provided for each column.
- repositoryPath: string
  
  The path of the repository to interrogate.
- gitOptions: string[] | ForEachRefOptions
  
  The ForEachRefOptions for the command. The ForEachRefOptions.--format option is required.
- Optional pattern: string
  
  Filters refs using either fnmatch(3) or matching completely or from the beginning up to a slash.
- Optional columnDelimiter: string
  
  The column delimiter used by gitOptions.ForEachRefOptions.--format. If unspecified, \t is used to split at %09 in gitOptions.ForEachRefOptions.--format.
Returns Promise<T[]>
An array containing objects passing the type guard function.