//#region src/filter.d.ts declare const filter: { /** * The `at` filter checks that the path matches the described value exactly. It takes a single * value for a field or an array (only for tags). * * {@link https://prismic.io/docs/rest-api-technical-reference#at} */ at: (path: string, value: string | number | boolean | Date | string[]) => string; /** * The `not` filter checks that the path doesn't match the provided value exactly. It takes a * single value for a field or an array (only for tags). * * {@link https://prismic.io/docs/rest-api-technical-reference#not} */ not: (path: string, value: string | number | boolean | Date | string[]) => string; /** * The `any` filter takes an array of values. It works exactly the same way as the `at` operator, * but checks whether the fragment matches any of the values in the array. * * {@link https://prismic.io/docs/rest-api-technical-reference#any} */ any: (path: string, values: (string | number | boolean | Date)[]) => string; /** * The `in` filter is used specifically to retrieve an array of documents by their IDs or UIDs. * This filter is much more efficient at this than the any filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#in} */ in: (path: string, values: string[]) => string; /** * The `fulltext` filter provides two capabilities: * * 1. Checking if a certain string is anywhere inside a document (this is what you should use to make * your project's search engine feature) * 2. Checking if the string is contained inside a specific custom type’s Rich Text or Key Text * fragment. * * {@link https://prismic.io/docs/rest-api-technical-reference#fulltext} */ fulltext: (path: string, searchTerms: string) => string; /** * The `has` filter checks whether a fragment has a value. It will return all the documents of the * specified type that contain a value for the specified field. * * {@link https://prismic.io/docs/rest-api-technical-reference#has} */ has: (path: string) => string; /** * The `missing` filter checks if a fragment doesn't have a value. It will return all the * documents of the specified type that do not contain a value for the specified field. * * {@link https://prismic.io/docs/rest-api-technical-reference#missing} */ missing: (path: string) => string; /** * The `similar` filter takes the ID of a document, and returns a list of documents with similar * content. This allows you to build an automated content discovery feature (for example, a * "Related posts" section). * * {@link https://prismic.io/docs/rest-api-technical-reference#similar} */ similar: (id: string, value: number) => string; /** * The `geopoint.near` filter checks that the value in the path is within the radius of the given * coordinates. * * This filter will only work for a geopoint field. * * {@link https://prismic.io/docs/rest-api-technical-reference#geopointnear} */ geopointNear: (path: string, latitude: number, longitude: number, radius: number) => string; /** * The `number.lt` filter checks that the value in the number field is less than the value passed * into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#numberlessthan} */ numberLessThan: (path: string, value: number) => string; /** * The `number.gt` filter checks that the value in the number field is greater than the value * passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#numbergreaterthan} */ numberGreaterThan: (path: string, value: number) => string; /** * The `number.inRange` filter checks that the value in the path is within the two values passed * into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#numberinrange} */ numberInRange: (path: string, lowerLimit: number, upperLimit: number) => string; /** * The `date.after` filter checks that the value in the path is after the date value passed into * the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateAfter: (path: string, date: string | number | Date) => string; /** * The `date.before` filter checks that the value in the path is before the date value passed into * the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateBefore: (path: string, date: string | number | Date) => string; /** * The `date.between` filter checks that the value in the path is within the date values passed * into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateBetween: (path: string, startDate: string | number | Date, endDate: string | number | Date) => string; /** * The `date.day-of-month` filter checks that the value in the path is equal to the day of the * month passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfMonth: (path: string, day: number) => string; /** * The `date.day-of-month-after` filter checks that the value in the path is after the day of the * month passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfMonthAfter: (path: string, day: number) => string; /** * The `date.day-of-month-before` filter checks that the value in the path is before the day of * the month passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfMonthBefore: (path: string, day: number) => string; /** * The `date.day-of-week` filter checks that the value in the path is equal to the day of the week * passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfWeek: (path: string, day: string | number) => string; /** * The `date.day-of-week-after` filter checks that the value in the path is after the day of the * week passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfWeekAfter: (path: string, day: string | number) => string; /** * The date.day-of-week-before filter checks that the value in the path is before the day of the * week passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateDayOfWeekBefore: (path: string, day: string | number) => string; /** * The `date.month` filter checks that the value in the path occurs in the month value passed into * the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateMonth: (path: string, month: string | number) => string; /** * The `date.month-after` filter checks that the value in the path occurs in any month after the * value passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateMonthAfter: (path: string, month: string | number) => string; /** * The `date.month-before` filter checks that the value in the path occurs in any month before the * value passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateMonthBefore: (path: string, month: string | number) => string; /** * The `date.year` filter checks that the value in the path occurs in the year value passed into * the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateYear: (path: string, year: number) => string; /** * The `date.hour` filter checks that the value in the path occurs within the hour value passed * into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateHour: (path: string, hour: number) => string; /** * The `date.hour-after` filter checks that the value in the path occurs after the hour value * passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateHourAfter: (path: string, hour: number) => string; /** * The `date.hour-before` filter checks that the value in the path occurs before the hour value * passed into the filter. * * {@link https://prismic.io/docs/rest-api-technical-reference#date-filters} */ dateHourBefore: (path: string, hour: number) => string; }; //#endregion export { filter }; //# sourceMappingURL=filter.d.ts.map