Add optional description to Token (#572)

* Add token description for documentation * Update API * Undo API change for `getRandomValues`
jupyterlab · Apr 7, 2023 · 0a699d6 · 0a699d6
1 parent 41341e8
commit 0a699d6
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/packages/coreutils/src/token.ts b/packages/coreutils/src/token.ts
@@ -20,12 +20,19 @@ export class Token<T> {
    * Construct a new token.
    *
    * @param name - A human readable name for the token.
+   * @param description - Token purpose description for documentation.
    */
-  constructor(name: string) {
+  constructor(name: string, description?: string) {
     this.name = name;
+    this.description = description ?? '';
     this._tokenStructuralPropertyT = null!;
   }
 
+  /**
+   * Token purpose description.
+   */
+  readonly description: string;
+
   /**
    * The human readable name for the token.
    *

diff --git a/packages/polling/tsconfig.json b/packages/polling/tsconfig.json
@@ -4,8 +4,7 @@
     "declarationDir": "types",
     "lib": ["DOM", "ES2018"],
     "outDir": "lib",
-    "rootDir": "src",
-    "types": ["@types/node"]
+    "rootDir": "src"
   },
   "include": ["src/*"],
   "references": [

diff --git a/review/api/coreutils.api.md b/review/api/coreutils.api.md
@@ -108,7 +108,8 @@ export type ReadonlyPartialJSONValue = JSONPrimitive | ReadonlyPartialJSONObject
 
 // @public
 export class Token<T> {
-    constructor(name: string);
+    constructor(name: string, description?: string);
+    readonly description: string;
     readonly name: string;
 }