Interface Translator

lib/translators/translator.ts:5–13

/** Translator interface for translating `QueryDescription` objects to regular queries. */
export interface Translator {
  /** Translate a query description into a regular query. */
  translateToQuery(query: QueryDescription): Query;

  /** Format a field to the database format, e.g. `userName` to `user_name`. */
  formatFieldNameToDatabase(
    fieldName: string | FieldAlias,
  ): string | FieldAlias;
}