yandex-metrica-ab-react
Version:
React библиотека для работы с AB экспериментами Метрики
29 lines (28 loc) • 1.08 kB
TypeScript
import { Config, NamedReturnType } from './types';
export interface UseExperiments {
/**
* Id of Varioqub client (metrika.XXXX)
* Read documentation (https://yandex.com/support/varioqub/en/objects/ymab)
*/
clientId: string;
/**
* Site user's ID.
* "icookie" in the documentation (https://yandex.com/support/varioqub/en/objects/ymab)
* Will be set and read by experimets code if not provided
*/
param?: string;
/**
* expjs configuration
* https://yandex.com/support/varioqub/en/objects/set-config
*/
config?: Partial<Config>;
/**
* User parameters.
* In the parameters, you can pass the properties of your site's users.
* For example, you can pass the site authorization flag.
* And configure experiment only for some group of users.
* Read documentation (https://yandex.com/support/varioqub/en/objects/ymab)
*/
clientFeatures?: Record<string, string>;
}
export declare const useExperiments: <T extends Record<string, string>>(params: UseExperiments) => NamedReturnType<T>;