graphql-compose-mongoose/lib/resolvers/helpers/filter.d.ts

Plugin for `graphql-compose` which derive a graphql types from a mongoose model.

import { ComposeFieldConfigArgumentMap, TypeComposer } from 'graphql-compose';
import { Model } from 'mongoose';
import { MongoId } from '../../types/mongoid';
import { ExtendedResolveParams } from '../index';
import { FilterOperatorsArgs, FilterOperatorsOpts } from './filterOperators';

export type FilterHelperArgsOpts = {
  filterTypeName?: string;
  isRequired?: boolean;
  onlyIndexed?: boolean;
  requiredFields?: string | string[];
  operators?: FilterOperatorsOpts | false;
  removeFields?: string | string[];
};

export type FilterHelperArgs<
  TSource = any,
  IndexedFieldsMap = { _id: MongoId }
> = TSource &
  FilterOperatorsArgs<TSource, IndexedFieldsMap> & {
    _ids: MongoId[];
  };

export function getFilterHelperArgOptsMap(): Partial<
  Record<keyof FilterHelperArgsOpts, string | string[]>
>;

export function filterHelperArgs(
  typeComposer: TypeComposer<any>,
  model: Model<any>,
  opts?: FilterHelperArgsOpts,
): ComposeFieldConfigArgumentMap;

export function filterHelper(resolveParams: ExtendedResolveParams): void;