@naturalcycles/abba 1.19.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +25 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@naturalcycles/abba",
3
- "version": "1.19.0",
3
+ "version": "1.20.0",
4
4
  "scripts": {
5
5
  "prepare": "husky"
6
6
  },
package/readme.md CHANGED
@@ -27,6 +27,7 @@
27
27
  </li>
28
28
  <li><a href="#usage">Usage</a></li>
29
29
  <li><a href="#segmentation">Segmentation</a></li>
30
+ <li><a href="#experiment-status">Experiment / Assignment statuses</a></li>
30
31
  <li><a href="#exclusion">Mutual Exclusion</a></li>
31
32
  </ol>
32
33
  </details>
@@ -57,7 +58,7 @@
57
58
 
58
59
  ## Getting Started
59
60
 
60
- <div id="gettingStarted"></div>
61
+ <div id="getting-started"></div>
61
62
 
62
63
  ### Prerequisites
63
64
 
@@ -293,6 +294,29 @@ Example segmentation data:
293
294
 
294
295
  <div id="exclusion"></div>
295
296
 
297
+ ## Experiment Status
298
+
299
+ <div id="experiment-status"></div>
300
+
301
+ ```js
302
+ export enum AssignmentStatus {
303
+ /**
304
+ * Will return existing assignments and generate new assignments
305
+ */
306
+ Active = 1,
307
+ /**
308
+ * Will return existing assignments but not generate new assignments
309
+ */
310
+ Paused = 2,
311
+ /**
312
+ * Will not return any assignments
313
+ */
314
+ Inactive = 3,
315
+ }
316
+ ```
317
+
318
+ <p align="right">(<a href="#top">back to top</a>)</p>
319
+
296
320
  ## Mutual Exclusion
297
321
 
298
322
  Mutual exclusion is configured per-experiment. If an experiment is listed as mutually exclusive with