Function createFilterWhereMethod

Returns (
    this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
        TData,
        TVirtual,
        ModelInstance<TData, TVirtual>,
        string,
    > & typeof Model & {
        _fieldMappings: Map<string, string>;
        _relations: Map<string, NormalizedRelationConfig>;
        _revisionHandlers?: Partial<
            Record<
                RevisionHandlerName,
                (this: Model, ...args: unknown[]) => unknown,
            >,
        >;
        _views: Map<
            string,
            ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
        >;
        dal: DataAccessLayer;
        options?: JsonObject;
        schema: ModelSchema<TData, TVirtual>;
        tableName: string;
    },
    literal: Partial<
        {
            [K in string
            | number
            | symbol]:
                | TData[K]
                | OperatorResultForKey<FilterWhereOperators<TData>, K>
        },
    >,
) => FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>

A filterWhere method bound to the model type

• • (
        this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
            TData,
            TVirtual,
            ModelInstance<TData, TVirtual>,
            string,
        > & typeof Model & {
            _fieldMappings: Map<string, string>;
            _relations: Map<string, NormalizedRelationConfig>;
            _revisionHandlers?: Partial<
                Record<
                    RevisionHandlerName,
                    (this: Model, ...args: unknown[]) => unknown,
                >,
            >;
            _views: Map<
                string,
                ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
            >;
            dal: DataAccessLayer;
            options?: JsonObject;
            schema: ModelSchema<TData, TVirtual>;
            tableName: string;
        },
        literal: Partial<
            {
                [K in string
                | number
                | symbol]:
                    | TData[K]
                    | OperatorResultForKey<FilterWhereOperators<TData>, K>
            },
        >,
    ): FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>

  • Typed entry point for building a filterWhere query.

    Parameters

    • this: ModelConstructor<TData, TVirtual, TInstance, TRelations> & ModelConstructor<
          TData,
          TVirtual,
          ModelInstance<TData, TVirtual>,
          string,
      > & typeof Model & {
          _fieldMappings: Map<string, string>;
          _relations: Map<string, NormalizedRelationConfig>;
          _revisionHandlers?: Partial<
              Record<
                  RevisionHandlerName,
                  (this: Model, ...args: unknown[]) => unknown,
              >,
          >;
          _views: Map<
              string,
              ModelViewDefinition<ModelInstance<JsonObject, JsonObject>, JsonObject>,
          >;
          dal: DataAccessLayer;
          options?: JsonObject;
          schema: ModelSchema<TData, TVirtual>;
          tableName: string;
      }

      Model constructor the query should operate on.
    • literal: Partial<
          {
              [K in string
              | number
              | symbol]: TData[K] | OperatorResultForKey<FilterWhereOperators<TData>, K>
          },
      >

      Initial predicate literal applied to the builder.

    Returns FilterWhereBuilder<TData, TVirtual, TInstance, TRelations>