@jupyterlab/observables 5.2.0-beta.0 → 5.2.0-beta.2

package/lib/modeldb.d.ts

@@ -120,7 +120,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Get a value for a path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns an `IObservable`.
      */
@@ -128,7 +128,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Whether the `IModelDB` has an object at this path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns a boolean for whether an object is at `path`.
      */
@@ -136,7 +136,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Create a string and insert it in the database.
      *
-     * @param path: the path for the string.
+     * @param path the path for the string.
      *
      * @returns the string that was created.
      */
@@ -144,7 +144,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Create an undoable list and insert it in the database.
      *
-     * @param path: the path for the list.
+     * @param path the path for the list.
      *
      * @returns the list that was created.
      *
@@ -156,7 +156,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Create a map and insert it in the database.
      *
-     * @param path: the path for the map.
+     * @param path the path for the map.
      *
      * @returns the map that was created.
      *
@@ -168,7 +168,7 @@ export interface IModelDB extends IDisposable {
     /**
      * Create an opaque value and insert it in the database.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
      * @returns the value that was created.
      */
@@ -177,22 +177,22 @@ export interface IModelDB extends IDisposable {
      * Get a value at a path, or `undefined if it has not been set
      * That value must already have been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      */
     getValue(path: string): JSONValue | undefined;
     /**
      * Set a value at a path. That value must already have
      * been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
-     * @param value: the new value.
+     * @param value the new value.
      */
     setValue(path: string, value: JSONValue): void;
     /**
      * Create a view onto a subtree of the model database.
      *
-     * @param basePath: the path for the root of the subtree.
+     * @param basePath the path for the root of the subtree.
      *
      * @returns an `IModelDB` with a view onto the original
      *   `IModelDB`, with `basePath` prepended to all paths.
@@ -210,7 +210,7 @@ export declare class ObservableValue implements IObservableValue {
     /**
      * Constructor for the value.
      *
-     * @param initialValue: the starting value for the `ObservableValue`.
+     * @param initialValue the starting value for the `ObservableValue`.
      */
     constructor(initialValue?: JSONValue);
     /**
@@ -295,7 +295,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Get a value for a path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns an `IObservable`.
      */
@@ -303,7 +303,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Whether the `IModelDB` has an object at this path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns a boolean for whether an object is at `path`.
      */
@@ -311,7 +311,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Create a string and insert it in the database.
      *
-     * @param path: the path for the string.
+     * @param path the path for the string.
      *
      * @returns the string that was created.
      */
@@ -319,7 +319,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Create an undoable list and insert it in the database.
      *
-     * @param path: the path for the list.
+     * @param path the path for the list.
      *
      * @returns the list that was created.
      *
@@ -331,7 +331,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Create a map and insert it in the database.
      *
-     * @param path: the path for the map.
+     * @param path the path for the map.
      *
      * @returns the map that was created.
      *
@@ -343,7 +343,7 @@ export declare class ModelDB implements IModelDB {
     /**
      * Create an opaque value and insert it in the database.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
      * @returns the value that was created.
      */
@@ -352,22 +352,22 @@ export declare class ModelDB implements IModelDB {
      * Get a value at a path, or `undefined if it has not been set
      * That value must already have been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      */
     getValue(path: string): JSONValue | undefined;
     /**
      * Set a value at a path. That value must already have
      * been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
-     * @param value: the new value.
+     * @param value the new value.
      */
     setValue(path: string, value: JSONValue): void;
     /**
      * Create a view onto a subtree of the model database.
      *
-     * @param basePath: the path for the root of the subtree.
+     * @param basePath the path for the root of the subtree.
      *
      * @returns an `IModelDB` with a view onto the original
      *   `IModelDB`, with `basePath` prepended to all paths.
@@ -378,9 +378,9 @@ export declare class ModelDB implements IModelDB {
      * be called by user code, instead use the
      * `create*` factory methods.
      *
-     * @param path: the path to set the value at.
+     * @param path the path to set the value at.
      *
-     * @param value: the value to set at the path.
+     * @param value the value to set at the path.
      */
     set(path: string, value: IObservable): void;
     /**

package/lib/modeldb.js

@@ -14,7 +14,7 @@ export class ObservableValue {
     /**
      * Constructor for the value.
      *
-     * @param initialValue: the starting value for the `ObservableValue`.
+     * @param initialValue the starting value for the `ObservableValue`.
      */
     constructor(initialValue = null) {
         this._value = null;
@@ -135,7 +135,7 @@ export class ModelDB {
     /**
      * Get a value for a path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns an `IObservable`.
      */
@@ -145,7 +145,7 @@ export class ModelDB {
     /**
      * Whether the `IModelDB` has an object at this path.
      *
-     * @param path: the path for the object.
+     * @param path the path for the object.
      *
      * @returns a boolean for whether an object is at `path`.
      */
@@ -155,7 +155,7 @@ export class ModelDB {
     /**
      * Create a string and insert it in the database.
      *
-     * @param path: the path for the string.
+     * @param path the path for the string.
      *
      * @returns the string that was created.
      */
@@ -168,7 +168,7 @@ export class ModelDB {
     /**
      * Create an undoable list and insert it in the database.
      *
-     * @param path: the path for the list.
+     * @param path the path for the list.
      *
      * @returns the list that was created.
      *
@@ -185,7 +185,7 @@ export class ModelDB {
     /**
      * Create a map and insert it in the database.
      *
-     * @param path: the path for the map.
+     * @param path the path for the map.
      *
      * @returns the map that was created.
      *
@@ -202,7 +202,7 @@ export class ModelDB {
     /**
      * Create an opaque value and insert it in the database.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
      * @returns the value that was created.
      */
@@ -216,7 +216,7 @@ export class ModelDB {
      * Get a value at a path, or `undefined if it has not been set
      * That value must already have been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      */
     getValue(path) {
         const val = this.get(path);
@@ -229,9 +229,9 @@ export class ModelDB {
      * Set a value at a path. That value must already have
      * been created using `createValue`.
      *
-     * @param path: the path for the value.
+     * @param path the path for the value.
      *
-     * @param value: the new value.
+     * @param value the new value.
      */
     setValue(path, value) {
         const val = this.get(path);
@@ -243,7 +243,7 @@ export class ModelDB {
     /**
      * Create a view onto a subtree of the model database.
      *
-     * @param basePath: the path for the root of the subtree.
+     * @param basePath the path for the root of the subtree.
      *
      * @returns an `IModelDB` with a view onto the original
      *   `IModelDB`, with `basePath` prepended to all paths.
@@ -258,9 +258,9 @@ export class ModelDB {
      * be called by user code, instead use the
      * `create*` factory methods.
      *
-     * @param path: the path to set the value at.
+     * @param path the path to set the value at.
      *
-     * @param value: the value to set at the path.
+     * @param value the value to set at the path.
      */
     set(path, value) {
         this._db.set(this._resolvePath(path), value);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/observables",
-  "version": "5.2.0-beta.0",
+  "version": "5.2.0-beta.2",
   "description": "Data structures which may be observed for changes.",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -29,7 +29,6 @@
     "build": "tsc -b",
     "build:test": "tsc --build tsconfig.test.json",
     "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
-    "docs": "typedoc src",
     "test": "jest",
     "test:cov": "jest --collect-coverage",
     "test:debug": "node --inspect-brk ../../node_modules/.bin/jest --runInBand",
@@ -44,11 +43,10 @@
     "@lumino/signaling": "^2.1.2"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.2.0-beta.0",
+    "@jupyterlab/testing": "^4.2.0-beta.2",
     "@types/jest": "^29.2.0",
     "jest": "^29.2.0",
     "rimraf": "~5.0.5",
-    "typedoc": "~0.24.7",
     "typescript": "~5.1.6"
   },
   "publishConfig": {

package/src/modeldb.ts

@@ -150,7 +150,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Get a value for a path.
    *
-   * @param path: the path for the object.
+   * @param path the path for the object.
    *
    * @returns an `IObservable`.
    */
@@ -159,7 +159,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Whether the `IModelDB` has an object at this path.
    *
-   * @param path: the path for the object.
+   * @param path the path for the object.
    *
    * @returns a boolean for whether an object is at `path`.
    */
@@ -168,7 +168,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Create a string and insert it in the database.
    *
-   * @param path: the path for the string.
+   * @param path the path for the string.
    *
    * @returns the string that was created.
    */
@@ -177,7 +177,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Create an undoable list and insert it in the database.
    *
-   * @param path: the path for the list.
+   * @param path the path for the list.
    *
    * @returns the list that was created.
    *
@@ -190,7 +190,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Create a map and insert it in the database.
    *
-   * @param path: the path for the map.
+   * @param path the path for the map.
    *
    * @returns the map that was created.
    *
@@ -203,7 +203,7 @@ export interface IModelDB extends IDisposable {
   /**
    * Create an opaque value and insert it in the database.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    *
    * @returns the value that was created.
    */
@@ -213,7 +213,7 @@ export interface IModelDB extends IDisposable {
    * Get a value at a path, or `undefined if it has not been set
    * That value must already have been created using `createValue`.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    */
   getValue(path: string): JSONValue | undefined;
 
@@ -221,16 +221,16 @@ export interface IModelDB extends IDisposable {
    * Set a value at a path. That value must already have
    * been created using `createValue`.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    *
-   * @param value: the new value.
+   * @param value the new value.
    */
   setValue(path: string, value: JSONValue): void;
 
   /**
    * Create a view onto a subtree of the model database.
    *
-   * @param basePath: the path for the root of the subtree.
+   * @param basePath the path for the root of the subtree.
    *
    * @returns an `IModelDB` with a view onto the original
    *   `IModelDB`, with `basePath` prepended to all paths.
@@ -250,7 +250,7 @@ export class ObservableValue implements IObservableValue {
   /**
    * Constructor for the value.
    *
-   * @param initialValue: the starting value for the `ObservableValue`.
+   * @param initialValue the starting value for the `ObservableValue`.
    */
   constructor(initialValue: JSONValue = null) {
     this._value = initialValue;
@@ -390,7 +390,7 @@ export class ModelDB implements IModelDB {
   /**
    * Get a value for a path.
    *
-   * @param path: the path for the object.
+   * @param path the path for the object.
    *
    * @returns an `IObservable`.
    */
@@ -401,7 +401,7 @@ export class ModelDB implements IModelDB {
   /**
    * Whether the `IModelDB` has an object at this path.
    *
-   * @param path: the path for the object.
+   * @param path the path for the object.
    *
    * @returns a boolean for whether an object is at `path`.
    */
@@ -412,7 +412,7 @@ export class ModelDB implements IModelDB {
   /**
    * Create a string and insert it in the database.
    *
-   * @param path: the path for the string.
+   * @param path the path for the string.
    *
    * @returns the string that was created.
    */
@@ -426,7 +426,7 @@ export class ModelDB implements IModelDB {
   /**
    * Create an undoable list and insert it in the database.
    *
-   * @param path: the path for the list.
+   * @param path the path for the list.
    *
    * @returns the list that was created.
    *
@@ -446,7 +446,7 @@ export class ModelDB implements IModelDB {
   /**
    * Create a map and insert it in the database.
    *
-   * @param path: the path for the map.
+   * @param path the path for the map.
    *
    * @returns the map that was created.
    *
@@ -464,7 +464,7 @@ export class ModelDB implements IModelDB {
   /**
    * Create an opaque value and insert it in the database.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    *
    * @returns the value that was created.
    */
@@ -479,7 +479,7 @@ export class ModelDB implements IModelDB {
    * Get a value at a path, or `undefined if it has not been set
    * That value must already have been created using `createValue`.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    */
   getValue(path: string): JSONValue | undefined {
     const val = this.get(path);
@@ -493,9 +493,9 @@ export class ModelDB implements IModelDB {
    * Set a value at a path. That value must already have
    * been created using `createValue`.
    *
-   * @param path: the path for the value.
+   * @param path the path for the value.
    *
-   * @param value: the new value.
+   * @param value the new value.
    */
   setValue(path: string, value: JSONValue): void {
     const val = this.get(path);
@@ -508,7 +508,7 @@ export class ModelDB implements IModelDB {
   /**
    * Create a view onto a subtree of the model database.
    *
-   * @param basePath: the path for the root of the subtree.
+   * @param basePath the path for the root of the subtree.
    *
    * @returns an `IModelDB` with a view onto the original
    *   `IModelDB`, with `basePath` prepended to all paths.
@@ -524,9 +524,9 @@ export class ModelDB implements IModelDB {
    * be called by user code, instead use the
    * `create*` factory methods.
    *
-   * @param path: the path to set the value at.
+   * @param path the path to set the value at.
    *
-   * @param value: the value to set at the path.
+   * @param value the value to set at the path.
    */
   set(path: string, value: IObservable): void {
     this._db.set(this._resolvePath(path), value);