Skip to content

Commit cf45f70

Browse files
Fix type definition comment
1 parent 09263b2 commit cf45f70

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

types/splitio.d.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1594,7 +1594,14 @@ declare namespace SplitIO {
15941594
/**
15951595
* Returns the current snapshot of the SDK rollout plan in cache.
15961596
*
1597-
* @param keys - Optional list of keys to generate the rollout plan snapshot with the memberships of the given keys, rather than the complete segments data.
1597+
* Wait for the SDK client to be ready before calling this method.
1598+
*
1599+
* ```js
1600+
* await factory.client().ready();
1601+
* const rolloutPlan = factory.getRolloutPlan();
1602+
* ```
1603+
*
1604+
* @param options - An object of type RolloutPlanOptions for advanced options.
15981605
* @returns The current snapshot of the SDK rollout plan.
15991606
*/
16001607
getRolloutPlan(options?: RolloutPlanOptions): RolloutPlan;

0 commit comments

Comments
 (0)