Search file text - Veryfront

fileTextSearch(input: FileTextSearchInput!): FileTextSearchResult!

Requires project.files.read.

Arguments

Argument	Type	Required
`input`	`FileTextSearchInput!`	Yes

Input fields

input

FileTextSearchInput

Field	Type	Required	Description
`projectReference`	`String`	No	Project UUID, slug or configured domain. Omit it to use the project of the request.
`ref`	`String`	No	Content to search: main, branch:<name-or-id>, release:<version> or env:<name>. Omit for main.
`query`	`String!`	Yes	Literal text to find, or a regular expression when isRegex is true.
`pattern`	`String`	No	File path pattern, for example .tsx or pages/.
`isRegex`	`Boolean`	No	Read query as a regular expression (default false).
`caseSensitive`	`Boolean`	No	Match letter case exactly (default false).
`limit`	`Int`	No	Largest number of matching files, 1 to 100 (default 50). It limits files, not matching lines.

Response

Returns FileTextSearchResult!. Open the type for its fields and nested types.

Field	Type
`data`	`[FileTextSearchFile!]!`
`totalMatches`	`Int!`

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

query FileTextSearch($input: FileTextSearchInput!) {
  fileTextSearch(input: $input) {
    totalMatches
    data {
      path
      versionId
    }
  }
}

{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "query": "example"
  }
}