Skip to content

Commit

Permalink
some more jsdoc for setKeysForSync, #95209
Browse files Browse the repository at this point in the history
  • Loading branch information
jrieken committed Oct 28, 2020
1 parent 69a9cb0 commit eec071e
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/vs/vscode.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5649,7 +5649,17 @@ declare module 'vscode' {
*/
readonly globalState: Memento & {
/**
* Set the keys whose values should be synced across devices while synchronizing the extension.
* Set the keys whose values should be synchronized across devices when synchronizing user-data
* like configuration, extensions, and mementos.
*
* Note that this function defines the whole set of keys whoses values should be synchronized:
* - calling it with an empty array stops synchronization for this memento
* - calling it with repeatedly with different arrays synchronizes the intersection
*
* For any given set of keys this function needs to be called only once but there is no harm in
* always repeatedly calling it.
*
* @param keys The set of keys whose values are synced.
*/
setKeysForSync(keys: string[]): void;
};
Expand Down

0 comments on commit eec071e

Please sign in to comment.