@jupyterlab/observables 2.1.1-alpha.0 → 2.1.1

package/lib/observablemap.js

@@ -1,180 +1,180 @@
-"use strict";
-// Copyright (c) Jupyter Development Team.
-// Distributed under the terms of the Modified BSD License.
-Object.defineProperty(exports, "__esModule", { value: true });
-const signaling_1 = require("@phosphor/signaling");
-/**
- * A concrete implementation of IObservbleMap<T>.
- */
-class ObservableMap {
-    /**
-     * Construct a new observable map.
-     */
-    constructor(options = {}) {
-        this._map = new Map();
-        this._changed = new signaling_1.Signal(this);
-        this._isDisposed = false;
-        this._itemCmp = options.itemCmp || Private.itemCmp;
-        if (options.values) {
-            for (let key in options.values) {
-                this._map.set(key, options.values[key]);
-            }
-        }
-    }
-    /**
-     * The type of the Observable.
-     */
-    get type() {
-        return 'Map';
-    }
-    /**
-     * A signal emitted when the map has changed.
-     */
-    get changed() {
-        return this._changed;
-    }
-    /**
-     * Whether this map has been disposed.
-     */
-    get isDisposed() {
-        return this._isDisposed;
-    }
-    /**
-     * The number of key-value pairs in the map.
-     */
-    get size() {
-        return this._map.size;
-    }
-    /**
-     * Set a key-value pair in the map
-     *
-     * @param key - The key to set.
-     *
-     * @param value - The value for the key.
-     *
-     * @returns the old value for the key, or undefined
-     *   if that did not exist.
-     *
-     * @throws if the new value is undefined.
-     *
-     * #### Notes
-     * This is a no-op if the value does not change.
-     */
-    set(key, value) {
-        let oldVal = this._map.get(key);
-        if (value === undefined) {
-            throw Error('Cannot set an undefined value, use remove');
-        }
-        // Bail if the value does not change.
-        let itemCmp = this._itemCmp;
-        if (oldVal !== undefined && itemCmp(oldVal, value)) {
-            return oldVal;
-        }
-        this._map.set(key, value);
-        this._changed.emit({
-            type: oldVal ? 'change' : 'add',
-            key: key,
-            oldValue: oldVal,
-            newValue: value
-        });
-        return oldVal;
-    }
-    /**
-     * Get a value for a given key.
-     *
-     * @param key - the key.
-     *
-     * @returns the value for that key.
-     */
-    get(key) {
-        return this._map.get(key);
-    }
-    /**
-     * Check whether the map has a key.
-     *
-     * @param key - the key to check.
-     *
-     * @returns `true` if the map has the key, `false` otherwise.
-     */
-    has(key) {
-        return this._map.has(key);
-    }
-    /**
-     * Get a list of the keys in the map.
-     *
-     * @returns - a list of keys.
-     */
-    keys() {
-        let keyList = [];
-        this._map.forEach((v, k) => {
-            keyList.push(k);
-        });
-        return keyList;
-    }
-    /**
-     * Get a list of the values in the map.
-     *
-     * @returns - a list of values.
-     */
-    values() {
-        let valList = [];
-        this._map.forEach((v, k) => {
-            valList.push(v);
-        });
-        return valList;
-    }
-    /**
-     * Remove a key from the map
-     *
-     * @param key - the key to remove.
-     *
-     * @returns the value of the given key,
-     *   or undefined if that does not exist.
-     */
-    delete(key) {
-        let oldVal = this._map.get(key);
-        this._map.delete(key);
-        this._changed.emit({
-            type: 'remove',
-            key: key,
-            oldValue: oldVal,
-            newValue: undefined
-        });
-        return oldVal;
-    }
-    /**
-     * Set the ObservableMap to an empty map.
-     */
-    clear() {
-        // Delete one by one to emit the correct signals.
-        let keyList = this.keys();
-        for (let i = 0; i < keyList.length; i++) {
-            this.delete(keyList[i]);
-        }
-    }
-    /**
-     * Dispose of the resources held by the map.
-     */
-    dispose() {
-        if (this.isDisposed) {
-            return;
-        }
-        this._isDisposed = true;
-        signaling_1.Signal.clearData(this);
-        this._map.clear();
-    }
-}
-exports.ObservableMap = ObservableMap;
-/**
- * The namespace for module private data.
- */
-var Private;
-(function (Private) {
-    /**
-     * The default strict equality item comparator.
-     */
-    function itemCmp(first, second) {
-        return first === second;
-    }
-    Private.itemCmp = itemCmp;
-})(Private || (Private = {}));
+"use strict";
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+Object.defineProperty(exports, "__esModule", { value: true });
+const signaling_1 = require("@phosphor/signaling");
+/**
+ * A concrete implementation of IObservbleMap<T>.
+ */
+class ObservableMap {
+    /**
+     * Construct a new observable map.
+     */
+    constructor(options = {}) {
+        this._map = new Map();
+        this._changed = new signaling_1.Signal(this);
+        this._isDisposed = false;
+        this._itemCmp = options.itemCmp || Private.itemCmp;
+        if (options.values) {
+            for (let key in options.values) {
+                this._map.set(key, options.values[key]);
+            }
+        }
+    }
+    /**
+     * The type of the Observable.
+     */
+    get type() {
+        return 'Map';
+    }
+    /**
+     * A signal emitted when the map has changed.
+     */
+    get changed() {
+        return this._changed;
+    }
+    /**
+     * Whether this map has been disposed.
+     */
+    get isDisposed() {
+        return this._isDisposed;
+    }
+    /**
+     * The number of key-value pairs in the map.
+     */
+    get size() {
+        return this._map.size;
+    }
+    /**
+     * Set a key-value pair in the map
+     *
+     * @param key - The key to set.
+     *
+     * @param value - The value for the key.
+     *
+     * @returns the old value for the key, or undefined
+     *   if that did not exist.
+     *
+     * @throws if the new value is undefined.
+     *
+     * #### Notes
+     * This is a no-op if the value does not change.
+     */
+    set(key, value) {
+        let oldVal = this._map.get(key);
+        if (value === undefined) {
+            throw Error('Cannot set an undefined value, use remove');
+        }
+        // Bail if the value does not change.
+        let itemCmp = this._itemCmp;
+        if (oldVal !== undefined && itemCmp(oldVal, value)) {
+            return oldVal;
+        }
+        this._map.set(key, value);
+        this._changed.emit({
+            type: oldVal ? 'change' : 'add',
+            key: key,
+            oldValue: oldVal,
+            newValue: value
+        });
+        return oldVal;
+    }
+    /**
+     * Get a value for a given key.
+     *
+     * @param key - the key.
+     *
+     * @returns the value for that key.
+     */
+    get(key) {
+        return this._map.get(key);
+    }
+    /**
+     * Check whether the map has a key.
+     *
+     * @param key - the key to check.
+     *
+     * @returns `true` if the map has the key, `false` otherwise.
+     */
+    has(key) {
+        return this._map.has(key);
+    }
+    /**
+     * Get a list of the keys in the map.
+     *
+     * @returns - a list of keys.
+     */
+    keys() {
+        let keyList = [];
+        this._map.forEach((v, k) => {
+            keyList.push(k);
+        });
+        return keyList;
+    }
+    /**
+     * Get a list of the values in the map.
+     *
+     * @returns - a list of values.
+     */
+    values() {
+        let valList = [];
+        this._map.forEach((v, k) => {
+            valList.push(v);
+        });
+        return valList;
+    }
+    /**
+     * Remove a key from the map
+     *
+     * @param key - the key to remove.
+     *
+     * @returns the value of the given key,
+     *   or undefined if that does not exist.
+     */
+    delete(key) {
+        let oldVal = this._map.get(key);
+        this._map.delete(key);
+        this._changed.emit({
+            type: 'remove',
+            key: key,
+            oldValue: oldVal,
+            newValue: undefined
+        });
+        return oldVal;
+    }
+    /**
+     * Set the ObservableMap to an empty map.
+     */
+    clear() {
+        // Delete one by one to emit the correct signals.
+        let keyList = this.keys();
+        for (let i = 0; i < keyList.length; i++) {
+            this.delete(keyList[i]);
+        }
+    }
+    /**
+     * Dispose of the resources held by the map.
+     */
+    dispose() {
+        if (this.isDisposed) {
+            return;
+        }
+        this._isDisposed = true;
+        signaling_1.Signal.clearData(this);
+        this._map.clear();
+    }
+}
+exports.ObservableMap = ObservableMap;
+/**
+ * The namespace for module private data.
+ */
+var Private;
+(function (Private) {
+    /**
+     * The default strict equality item comparator.
+     */
+    function itemCmp(first, second) {
+        return first === second;
+    }
+    Private.itemCmp = itemCmp;
+})(Private || (Private = {}));

package/lib/observablestring.d.ts

@@ -1,147 +1,147 @@
-import { IDisposable } from '@phosphor/disposable';
-import { ISignal } from '@phosphor/signaling';
-import { IObservable } from './modeldb';
-/**
- * A string which can be observed for changes.
- */
-export interface IObservableString extends IDisposable, IObservable {
-    /**
-     * The type of the Observable.
-     */
-    type: 'String';
-    /**
-     * A signal emitted when the string has changed.
-     */
-    readonly changed: ISignal<this, IObservableString.IChangedArgs>;
-    /**
-     * The value of the string.
-     */
-    text: string;
-    /**
-     * Insert a substring.
-     *
-     * @param index - The starting index.
-     *
-     * @param text - The substring to insert.
-     */
-    insert(index: number, text: string): void;
-    /**
-     * Remove a substring.
-     *
-     * @param start - The starting index.
-     *
-     * @param end - The ending index.
-     */
-    remove(start: number, end: number): void;
-    /**
-     * Set the ObservableString to an empty string.
-     */
-    clear(): void;
-    /**
-     * Dispose of the resources held by the string.
-     */
-    dispose(): void;
-}
-/**
- * The namespace for `IObservableString` associate interfaces.
- */
-export declare namespace IObservableString {
-    /**
-     * The change types which occur on an observable string.
-     */
-    type ChangeType = 'insert'
-    /**
-     * Text was removed.
-     */
-     | 'remove'
-    /**
-     * Text was set.
-     */
-     | 'set';
-    /**
-     * The changed args object which is emitted by an observable string.
-     */
-    interface IChangedArgs {
-        /**
-         * The type of change undergone by the list.
-         */
-        type: ChangeType;
-        /**
-         * The starting index of the change.
-         */
-        start: number;
-        /**
-         * The end index of the change.
-         */
-        end: number;
-        /**
-         * The value of the change.
-         *
-         * ### Notes
-         * If `ChangeType` is `set`, then
-         * this is the new value of the string.
-         *
-         * If `ChangeType` is `insert` this is
-         * the value of the inserted string.
-         *
-         * If `ChangeType` is remove this is the
-         * value of the removed substring.
-         */
-        value: string;
-    }
-}
-/**
- * A concrete implementation of [[IObservableString]]
- */
-export declare class ObservableString implements IObservableString {
-    /**
-     * Construct a new observable string.
-     */
-    constructor(initialText?: string);
-    /**
-     * The type of the Observable.
-     */
-    readonly type: 'String';
-    /**
-     * A signal emitted when the string has changed.
-     */
-    readonly changed: ISignal<this, IObservableString.IChangedArgs>;
-    /**
-     * Set the value of the string.
-     */
-    /**
-    * Get the value of the string.
-    */
-    text: string;
-    /**
-     * Insert a substring.
-     *
-     * @param index - The starting index.
-     *
-     * @param text - The substring to insert.
-     */
-    insert(index: number, text: string): void;
-    /**
-     * Remove a substring.
-     *
-     * @param start - The starting index.
-     *
-     * @param end - The ending index.
-     */
-    remove(start: number, end: number): void;
-    /**
-     * Set the ObservableString to an empty string.
-     */
-    clear(): void;
-    /**
-     * Test whether the string has been disposed.
-     */
-    readonly isDisposed: boolean;
-    /**
-     * Dispose of the resources held by the string.
-     */
-    dispose(): void;
-    private _text;
-    private _isDisposed;
-    private _changed;
-}
+import { IDisposable } from '@phosphor/disposable';
+import { ISignal } from '@phosphor/signaling';
+import { IObservable } from './modeldb';
+/**
+ * A string which can be observed for changes.
+ */
+export interface IObservableString extends IDisposable, IObservable {
+    /**
+     * The type of the Observable.
+     */
+    type: 'String';
+    /**
+     * A signal emitted when the string has changed.
+     */
+    readonly changed: ISignal<this, IObservableString.IChangedArgs>;
+    /**
+     * The value of the string.
+     */
+    text: string;
+    /**
+     * Insert a substring.
+     *
+     * @param index - The starting index.
+     *
+     * @param text - The substring to insert.
+     */
+    insert(index: number, text: string): void;
+    /**
+     * Remove a substring.
+     *
+     * @param start - The starting index.
+     *
+     * @param end - The ending index.
+     */
+    remove(start: number, end: number): void;
+    /**
+     * Set the ObservableString to an empty string.
+     */
+    clear(): void;
+    /**
+     * Dispose of the resources held by the string.
+     */
+    dispose(): void;
+}
+/**
+ * The namespace for `IObservableString` associate interfaces.
+ */
+export declare namespace IObservableString {
+    /**
+     * The change types which occur on an observable string.
+     */
+    type ChangeType = 'insert'
+    /**
+     * Text was removed.
+     */
+     | 'remove'
+    /**
+     * Text was set.
+     */
+     | 'set';
+    /**
+     * The changed args object which is emitted by an observable string.
+     */
+    interface IChangedArgs {
+        /**
+         * The type of change undergone by the list.
+         */
+        type: ChangeType;
+        /**
+         * The starting index of the change.
+         */
+        start: number;
+        /**
+         * The end index of the change.
+         */
+        end: number;
+        /**
+         * The value of the change.
+         *
+         * ### Notes
+         * If `ChangeType` is `set`, then
+         * this is the new value of the string.
+         *
+         * If `ChangeType` is `insert` this is
+         * the value of the inserted string.
+         *
+         * If `ChangeType` is remove this is the
+         * value of the removed substring.
+         */
+        value: string;
+    }
+}
+/**
+ * A concrete implementation of [[IObservableString]]
+ */
+export declare class ObservableString implements IObservableString {
+    /**
+     * Construct a new observable string.
+     */
+    constructor(initialText?: string);
+    /**
+     * The type of the Observable.
+     */
+    readonly type: 'String';
+    /**
+     * A signal emitted when the string has changed.
+     */
+    readonly changed: ISignal<this, IObservableString.IChangedArgs>;
+    /**
+     * Set the value of the string.
+     */
+    /**
+    * Get the value of the string.
+    */
+    text: string;
+    /**
+     * Insert a substring.
+     *
+     * @param index - The starting index.
+     *
+     * @param text - The substring to insert.
+     */
+    insert(index: number, text: string): void;
+    /**
+     * Remove a substring.
+     *
+     * @param start - The starting index.
+     *
+     * @param end - The ending index.
+     */
+    remove(start: number, end: number): void;
+    /**
+     * Set the ObservableString to an empty string.
+     */
+    clear(): void;
+    /**
+     * Test whether the string has been disposed.
+     */
+    readonly isDisposed: boolean;
+    /**
+     * Dispose of the resources held by the string.
+     */
+    dispose(): void;
+    private _text;
+    private _isDisposed;
+    private _changed;
+}