Skip to content

Document evaluation options for JavaScript client methods #2892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

Document evaluation options for JavaScript client methods

This PR adds documentation for the evaluation options that can be passed to methods like checkGate, getDynamicConfig, getExperiment, and getLayer.

Changes

  • Created a new file _evaluationOptions.mdx to document method options
  • Added documentation for disableExposureLog option
  • Added documentation for userPersistedValues option for experiments
  • Updated the JavaScript SDK documentation to include the new section

Context

This addresses undocumented options that exist in the codebase but weren't fully documented in the docs site. These options are important for users who need to control exposure logging or implement persistent experiment assignments.

Link to Devin run: https://app.devin.ai/sessions/e4356647bbb84f41938f98e9528d0299
Requested by: [email protected]

Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@jasonwzm
Copy link
Member

jasonwzm commented Apr 17, 2025

🚀 Deployed on https://680197a7e9f6903635e9deff--cozy-fox-0defec.netlify.app

@jasonwzm jasonwzm temporarily deployed to pull request April 17, 2025 23:46 Inactive
@jasonwzm jasonwzm temporarily deployed to pull request April 18, 2025 00:08 Inactive
@tore-statsig
Copy link
Contributor

only use relative links to other documentation like: /client/concepts/persistent_assignment#example-usage

Also remove the existing exposure logging disabled docs file

@tore-statsig
Copy link
Contributor

build fails - something is still relying on the manual exposures doc. can you update it to rely on the new method options doc

It might be react or another sdk which would require a slightly different doc (e.g. the react hooks have different parameters)

@tore-statsig
Copy link
Contributor

Actually, I think we need to update this. The persistent assignment is documented here

https://docs.statsig.com/server/concepts/persistent_assignment/

And we want to keep it there since it is advanced. But each sdk repository should note the evaluation options that you can use, but likely only needs to give the disable exposure logging example, and keep the persistent assignment examples in that other doc

devin-ai-integration bot and others added 13 commits April 21, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants