Type Alias FulltextSearchStoreConfig<R>

FulltextSearchStoreConfig: {
    adapter: FullTextSearchAdapter;
    existingIndexTypes?: string[];
    idCodec?: IndexIdCodec;
    idCodecForType?: (typeName: string) => IndexIdCodec | undefined;
    indexNameForType?: (typeName: string) => string;
    primaryFields: PrimaryFieldDeclaration;
    primaryStore: PrimaryStore<R>;
    schema: JSONSchema7;
    scopeToIndexField?: Record<string, string>;
    searchFacetSchema: SearchFacetSchema;
    storeId?: string;
}

Type Parameters

  • R extends SchemaRegistry = SchemaRegistry

Type declaration

  • adapter: FullTextSearchAdapter
  • OptionalexistingIndexTypes?: string[]

    Type names whose indexes already exist — skip ensureIndex in prepareFulltextIndexes.

  • OptionalidCodec?: IndexIdCodec

    Global document id codec (default: base64url full IRI).

  • OptionalidCodecForType?: (typeName: string) => IndexIdCodec | undefined

    Per-type codec override (e.g. legacy hex ids for one index).

  • OptionalindexNameForType?: (typeName: string) => string
  • primaryFields: PrimaryFieldDeclaration
  • primaryStore: PrimaryStore<R>
  • schema: JSONSchema7
  • OptionalscopeToIndexField?: Record<string, string>
  • searchFacetSchema: SearchFacetSchema
  • OptionalstoreId?: string

Settings

Member Visibility