Class●Since v1.1

CustomFilter

Custom filter for providing raw RediSearch query syntax.

This filter allows you to provide a custom RediSearch query string that will be used as-is without any modification. This is useful when you need to use advanced RediSearch features that are not covered by the other filter types, or when you want complete control over the query syntax.

Warning: When using custom filters, you are responsible for ensuring the query syntax is valid RediSearch syntax. Invalid syntax will cause search queries to fail.

class CustomFilter

Bases

FilterExpression

Example

// Simple custom filter
const filter = new CustomFilter("@category:{electronics}");

// Complex custom filter with multiple conditions
const filter = new CustomFilter("(@category:{electronics} @price:[0 100])");

// Using advanced RediSearch features
const filter = new CustomFilter("@title:(wireless|bluetooth) @price:[50 200]");

// Combining with other filters
const filter = new CustomFilter("@category:{electronics}")
  .and(Num("price").lt(100));

// Using the convenience function
const filter = Custom("(@brand:{Apple} @year:[2020 +inf])");