stratadb / StringOperator

Type Alias: StringOperator

type StringOperator = object;

Defined in: src/query-types.ts:151

String-specific query operators for pattern matching.

Remarks

These operators provide MongoDB-like string matching capabilities with full type safety. Only available for string fields to prevent runtime errors.

For complex pattern matching that would typically use regular expressions, consider using these alternatives:

• $like: For SQL-style pattern matching with % wildcards
• $startsWith: For prefix matching (more efficient than regex)
• $endsWith: For suffix matching (more efficient than regex)

Example

// ✅ Valid string queries
const emailQuery: StringOperator = {
  $like: '%@example.com',     // SQL LIKE pattern
  $startsWith: 'admin',      // Starts with prefix
  $endsWith: '@domain.com'   // Ends with suffix
};

// ✅ Pattern matching alternatives
const namePatterns: StringOperator = {
  $startsWith: 'A',          // Names starting with 'A'
  $endsWith: 'son',          // Names ending with 'son'
  $like: '%admin%'           // Contains 'admin' anywhere
};

// ✅ Combining multiple string conditions
const complexStringQuery: StringOperator = {
  $startsWith: 'Dr.',
  $like: '%PhD%'
};

Properties

$endsWith?

readonly optional $endsWith: string;

Defined in: src/query-types.ts:159

String ends with the specified suffix

---

$like?

readonly optional $like: string;

Defined in: src/query-types.ts:153

SQL-style LIKE pattern matching

---

$startsWith?

readonly optional $startsWith: string;

Defined in: src/query-types.ts:156

String starts with the specified prefix