metadata.d.ts 1.1 KB

123456789101112131415161718192021222324252627282930313233
  1. import { UserAgent } from '@algolia/autocomplete-shared';
  2. import { AutocompleteEnvironment, AutocompleteOptionsWithMetadata, AutocompletePlugin, BaseItem } from '.';
  3. declare type AutocompleteMetadata = {
  4. plugins: Array<{
  5. name: string | undefined;
  6. options: string[];
  7. }>;
  8. options: Record<string, string[]>;
  9. ua: UserAgent[];
  10. };
  11. declare type GetMetadataParams<TItem extends BaseItem, TData = unknown> = {
  12. plugins: Array<AutocompletePlugin<TItem, TData>>;
  13. options: AutocompleteOptionsWithMetadata<TItem>;
  14. };
  15. export declare function getMetadata<TItem extends BaseItem, TData = unknown>({ plugins, options, }: GetMetadataParams<TItem, TData>): {
  16. plugins: {
  17. name: string | undefined;
  18. options: string[];
  19. }[];
  20. options: {
  21. 'autocomplete-core': string[];
  22. };
  23. ua: {
  24. segment: string;
  25. version: string;
  26. }[];
  27. };
  28. declare type InlineMetadataParams = {
  29. metadata: AutocompleteMetadata;
  30. environment: AutocompleteEnvironment;
  31. };
  32. export declare function injectMetadata({ metadata, environment, }: InlineMetadataParams): void;
  33. export {};