Function getWhereis

getWhereis<T>(guard, columns, repositoryPath, anxOptions, relativePaths?, columnDelimiter?): Promise<T[]>
Returns information about repositories containing files in application-defined JavaScript objects. The JavaScript objects are created from the return of the GitAnnexAPI.whereis method.
Type Parameters
- T
  
  The application-defined type of the returned objects.
Parameters
- guard: ((o) => o is T)
  
  The type predicate to validate each file.
  - - (o): o is T
    - Parameters
      
      o: unknown
      
      Returns o is T
- columns: [string, Parser?][]
  
  Maps the columns returned by anxOptions.WhereisOptions.--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.
- anxOptions: string[] | WhereisOptions
  
  The WhereisOptions for the command. The WhereisOptions.--format option is required and must end with \\n.
- Optional relativePaths: string | string[]
  
  The files for the whereis command. If specified, helper function gitPath or gitPaths is called internally.
- Optional columnDelimiter: string
  
  The column delimiter used by anxOptions.WhereisOptions.--format. If unspecified, \t is used to split at \\t in anxOptions.WhereisOptions.--format.
Returns Promise<T[]>
An array containing objects passing the type guard function.