graphile-search-plugin/preset.d.ts

Generate search conditions for your tsvector columns (PostGraphile v5)

/**
 * PostGraphile v5 Search Preset
 *
 * Provides a convenient preset for including search support in PostGraphile.
 */
import type { GraphileConfig } from 'graphile-config';
import type { PgSearchPluginOptions } from './types';
/**
 * Creates a preset that includes the search plugin with the given options.
 *
 * @example
 * ```typescript
 * import { PgSearchPreset } from 'graphile-search-plugin';
 *
 * const preset = {
 *   extends: [
 *     PgSearchPreset({
 *       pgSearchPrefix: 'fullText',
 *     }),
 *   ],
 * };
 * ```
 */
export declare function PgSearchPreset(options?: PgSearchPluginOptions): GraphileConfig.Preset;
export default PgSearchPreset;