# @types/marvelapp__react-ab-test

> TypeScript definitions for @marvelapp/react-ab-test

Latest version **3.1.4** (published 2023-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/marvelapp__react-ab-test
pnpm add @types/marvelapp__react-ab-test
yarn add @types/marvelapp__react-ab-test
bun add @types/marvelapp__react-ab-test
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.1.4 |
| Published | 2023-12-04 |
| First published | 2021-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/marvelapp__react-ab-test
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/marvelapp__react-ab-test
- npm.io page: https://npm.io/package/@types/marvelapp__react-ab-test

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 3.1.4 (latest) — 2023-12-04
- 3.1.3 (ts4.5) — 2023-11-07
- 3.1.0 (ts3.6) — 2021-08-10
- 3.1.2 — 2023-10-18
- 3.1.1 — 2023-09-27

## README

# Installation
> `npm install --save @types/marvelapp__react-ab-test`

# Summary
This package contains type definitions for @marvelapp/react-ab-test (https://github.com/marvelapp/react-ab-test#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/marvelapp__react-ab-test.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/marvelapp__react-ab-test/index.d.ts)
````ts
import { JSX } from "react";

export type ListenerCallback = (experimentName: string, variantName: string) => void;
export interface Subscription {
    remove(): void;
    listener: ListenerCallback;
    eventType: string;
}

export namespace emitter {
    function emitWin(experimentName: string): void;
    function addActiveVariantListener(eventName: string | ListenerCallback, callback?: ListenerCallback): Subscription;
    function addPlayListener(eventName: string | ListenerCallback, callback?: ListenerCallback): Subscription;
    function addWinListener(eventName: string | ListenerCallback, callback?: ListenerCallback): Subscription;
    function defineVariants(experimentName: string, variantNames: string[], variantWeights?: number[]): void;
    function setActiveVariant(experimentName: string, variantName: string): void;
    function getActiveVariant(experimentName: string): string;
    function calculateActiveVariant(
        experimentName: string,
        userIdentifier?: string,
        defaultVariantName?: string,
    ): string;
    function getSortedVariants(experimentName: string): string[];
    function setCustomDistributionAlgorithm(
        customAlgorithm: (experimentName: string, userIdentifier: string, defaultVariantName?: string) => void,
    ): void;
}

export interface ExperimentProps {
    name: string;
    defaultVariantName?: string;
    userIdentifier?: string;
    children: React.ReactNode;
}

export function Experiment({
    name,
    defaultVariantName,
    userIdentifier,
    children,
}: ExperimentProps): JSX.Element;

export function Variant({
    name,
    children,
}: { name: string; children: React.ReactNode }): JSX.Element;

export namespace experimentDebugger {
    function setDebuggerAvailable(isAvailable: boolean): void;
    function enable(): void;
    function disable(): void;
}

export namespace mixpanelHelper {
    function enable(): void;
    function disable(): void;
}

export namespace segmentHelper {
    function enable(): void;
    function disable(): void;
}

````

### Additional Details
 * Last updated: Mon, 04 Dec 2023 17:35:44 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [mtayllan](https://github.com/mtayllan).

---
_Source: https://npm.io/package/@types/marvelapp__react-ab-test · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._