Document evaluation options for JavaScript client methods

docs/server-core/Templates/_ManualExposures.mdx → docs/client/Templates/_EvaluationOptions.mdx

@@ -1,18 +1,20 @@
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
+import { VersionBadge } from "../../sdks/_VersionBadge.mdx";
 
-## Manual Exposures 
+## Method Options <VersionBadge version={props.addedInVersion}/>
+
+When using methods like `checkGate`, `getDynamicConfig`, `getExperiment`, and `getLayer`, you can pass an options object as the second parameter to customize the behavior:
+
+### disableExposureLog `boolean`
+> Prevents an exposure log being created for this check. Use this when you want to check a value without recording that the user was exposed to it.
+>
+> default: `false`
 
 :::warning
 Manually logging exposures can be tricky and may lead to an imbalance in exposure events. For example, only triggering exposures for users in the Test group of an experiment will imbalance the experiment, making it useless.
 :::
 
-<>
-  Added in version {props.addedInVersion}, you can now query your
-  gates/experiments without triggering an exposure as well as manually logging
-  your exposures.
-</>
-
 <Tabs
   defaultValue="gate"
   values={[
@@ -24,50 +26,61 @@ Manually logging exposures can be tricky and may lead to an imbalance in exposur
 
 <TabItem value="gate">
 
-To check a gate without an exposure being logged, call the following.
+To check a gate without an exposure being logged, call the following:
 
 <div>{props.gateSnippet}</div>
 
-Later, if you would like to expose this gate, you can call the following.
+Later, if you would like to expose this gate, you can call the following:
 
 <div>{props.gateExposureSnippet}</div>
 
 </TabItem>
 
 <TabItem value="config">
 
-To get a dynamic config without an exposure being logged, call the following.
+To get a dynamic config without an exposure being logged, call the following:
 
 <div>{props.configSnippet}</div>
 
-Later, if you would like to expose the dynamic config, you can call the following.
+Later, if you would like to expose the dynamic config, you can call the following:
 
 <div>{props.configExposureSnippet}</div>
 
 </TabItem>
 
 <TabItem value="experiment">
 
-To get an experiment without an exposure being logged, call the following.
+To get an experiment without an exposure being logged, call the following:
 
 <div>{props.experimentSnippet}</div>
 
-Later, if you would like to expose the experiment, you can call the following.
+Later, if you would like to expose the experiment, you can call the following:
 
 <div>{props.experimentExposureSnippet}</div>
 
 </TabItem>
 
 <TabItem value="layer">
 
-To get a layer parameter without an exposure being logged, call the following.
+To get a layer parameter without an exposure being logged, call the following:
 
 <div>{props.layerSnippet}</div>
 
-Later, if you would like to expose the layer parameter, you can call the following.
+Later, if you would like to expose the layer parameter, you can call the following:
 
 <div>{props.layerExposureSnippet}</div>
 
 </TabItem>
 
 </Tabs>
+
+{props.userPersistedValues && (
+  <>
+    ### userPersistedValues `object`
+    {"> Provide a map of values to be used for persistent experiment assignments. This requires a user persistent storage adapter.\n>\n> Only available for `getExperiment` method."}
+
+    <div>{props.userPersistedValuesSnippet}</div>
+
+    {"For more information on persistent assignments, see the [Persistent Assignment documentation](/client/concepts/persistent_assignment#example-usage)."}
+  </>
+)}

docs/client/Templates/index.mdx

@@ -22,8 +22,8 @@ export const PrefetchUsers = _PrefetchUsers;
 import * as _StableID from "./_StableID.mdx";
 export const StableID = _StableID;
 
-import * as _ManualExposures from "./_ManualExposures.mdx";
-export const ManualExposures = _ManualExposures;
+import * as _EvaluationOptions from "./_EvaluationOptions.mdx";
+export const EvaluationOptions = _EvaluationOptions;
 
 import * as _Shutdown from "./_Shutdown.mdx";
 export const Shutdown = _Shutdown;

docs/client/androidClientSDK.mdx

@@ -22,7 +22,7 @@ import {
   StatsigUser,
   StatsigOptions,
   PrefetchUsers,
-  ManualExposures,
+  EvaluationOptions,
   Shutdown,
   LocalOverrides,
   StableID,
@@ -42,7 +42,7 @@ import Options from "./Android/_options.mdx";
 import LocalOverridesSnippet from "./Android/_localOverrides.mdx";
 import ShutdownSnippet from "./Android/_shutdown.mdx";
 import { GetStableID, OverrideStableID } from "./Android/_stableID.mdx";
-import { Snippets as ManualExposureSnippets } from "./Android/_manualExposures.mdx";
+// EvaluationOptions now replaces manual exposures
 import GetParameterStore from "./Android/_getParameterStore.mdx";
 import GetParameter from "./Android/_getParameter.mdx";
 import MultiInstance from "./Android/_multiInstance.mdx";
@@ -80,7 +80,7 @@ export const Builder = SDKDocsBuilder({
     [StatsigOptions, { options: <Options /> }],
     [Shutdown, { shutdown: <ShutdownSnippet /> }],
     [LocalOverrides, { localOverrides: <LocalOverridesSnippet /> }],
-    [ManualExposures, { addedInVersion: "4.9.0", ...ManualExposureSnippets }],
+    [EvaluationOptions, { addedInVersion: "4.9.0" }],
     [
       StableID,
       { getSnippet: <GetStableID />, overrideSnippet: <OverrideStableID /> },

docs/client/cpp-client-sdk.mdx

@@ -20,7 +20,7 @@ import {
   StatsigUser,
   StatsigOptions,
   PrefetchUsers,
-  ManualExposures,
+  EvaluationOptions,
   Shutdown,
   LocalOverrides,
 } from "./Templates/index.mdx";

docs/client/dartSDK.mdx

@@ -20,7 +20,7 @@ import {
   StatsigUser,
   StatsigOptions,
   PrefetchUsers,
-  ManualExposures,
+  EvaluationOptions,
   Shutdown,
   ParameterStore,
   LocalOverrides,