@fluidframework/map 1.2.2 → 2.0.0-internal.1.0.0.82159

package/lib/interfaces.d.ts

@@ -84,167 +84,125 @@ export interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryE
     getWorkingDirectory(relativePath: string): IDirectory | undefined;
 }
 /**
- * Events emitted in response to changes to the directory data. These events only emit on the ISharedDirectory itself,
- * and not on subdirectories.
- *
- * @remarks
- *
- * The following is the list of events emitted.
- *
- * ### "valueChanged"
- *
- * The valueChanged event is emitted when a key is set or deleted.  This is emitted for any key in the ISharedDirectory
- * or any subdirectory.
- *
- * #### Listener signature
- *
- * ```typescript
- * (
- *     changed: IDirectoryValueChanged,
- *     local: boolean,
- *     target: IEventThisPlaceHolder,
- * ) => void
- * ```
- * - `changed` - Information on the key that changed, its value prior to the change, and the path to the key that
- *   changed.
- *
- * - `local` - Whether the change originated from this client.
- *
- * - `target` - The ISharedDirectory itself.
- *
- * ### "clear"
- *
- * The clear event is emitted when the ISharedDirectory is cleared.
- *
- * #### Listener signature
- *
- * ```typescript
- * (local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `local` - Whether the clear originated from this client.
- *
- * - `target` - The ISharedDirectory itself.
- *
- * ### "subDirectoryCreated"
- *
- * The subDirectoryCreated event is emitted when a subdirectory is created.
- *
- * #### Listener signature
- *
- * ```typescript
- * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `path` -  The relative path to the subdirectory that is created.
- *             It is relative from the object which raises the event.
- *
- * - `local` - Whether the create originated from the this client.
- *
- * - `target` - The ISharedDirectory itself.
- *
- * ###"subDirectoryDeleted"
- *
- * The subDirectoryDeleted event is emitted when a subdirectory is deleted.
- *
- * #### Listener signature
- *
- * ```typescript
- * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `path` - The relative path to the subdirectory that is deleted.
- *            It is relative from the object which raises the event.
- *
- * - `local` - Whether the delete originated from the this client.
- *
- * - `target` - The ISharedDirectory itself.
+ * Events emitted in response to changes to the directory data.
+ * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.
  */
 export interface ISharedDirectoryEvents extends ISharedObjectEvents {
+    /**
+    * Emitted when a key is set or deleted. This is emitted for any key in the {@link ISharedDirectory} or any
+    * subdirectory.
+    *
+    * @remarks Listener parameters:
+    *
+    * - `changed` - Information on the key that changed, its value prior to the change, and the path to the
+    * key that changed.
+    *
+    * - `local` - Whether the change originated from this client.
+    *
+    * - `target` - The {@link ISharedDirectory} itself.
+    */
     (event: "valueChanged", listener: (changed: IDirectoryValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when the {@link ISharedDirectory} is cleared.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `local` - Whether the clear originated from this client.
+     *
+     * - `target` - The {@link ISharedDirectory} itself.
+     */
     (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when a subdirectory is created.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `path` - The relative path to the subdirectory that is created.
+     * It is relative from the object which raises the event.
+     *
+     * - `local` - Whether the create originated from the this client.
+     *
+     * - `target` - The {@link ISharedDirectory} itself.
+     */
     (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when a subdirectory is deleted.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `path` - The relative path to the subdirectory that is deleted.
+     * It is relative from the object which raises the event.
+     *
+     * - `local` - Whether the delete originated from the this client.
+     *
+     * - `target` - The {@link ISharedDirectory} itself.
+     */
     (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
 }
 /**
  * Events emitted in response to changes to the directory data.
- *
- * @remarks
- *
- * The following is the list of events emitted.
- *
- * ### "containedValueChanged"
- *
- * The containedValueChanged event is emitted when a key is set or deleted.  As opposed to the SharedDirectory's
- * valueChanged event, this is emitted only on the IDirectory that directly contains the key.
- *
- * #### Listener signature
- *
- * ```typescript
- * (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `changed` - Information on the key that changed and its value prior to the change.
- *
- * - `local` - Whether the change originated from this client.
- *
- * - `target` - The IDirectory itself.
- *
- * ### "subDirectoryCreated"
- *
- * The subDirectoryCreated event is emitted when a subdirectory is created.
- *
- * #### Listener signature
- *
- * ```typescript
- * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `path` - The relative path to the subdirectory that is created.
- *            It is relative from the object which raises the event.
- *
- * - `local` - Whether the creation originated from the this client.
- *
- * - `target` - The ISharedDirectory itself.
- *
- * ### "subDirectoryDeleted"
- *
- * The subDirectoryDeleted event is emitted when a subdirectory is deleted.
- *
- * #### Listener signature
- *
- * ```typescript
- * (path: string, local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `path` - The relative path to the subdirectory that is deleted.
- *            It is relative from the object which raises the event.
- *
- * - `local` - Whether the delete originated from the this client.
- *
- * - `target` - The ISharedDirectory itself.
- *
- * ### "disposed"
- *
- * The dispose event is emitted when this sub directory is deleted.
- *
- * #### Listener signature
- *
- * ```typescript
- * (local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- *
- * - `target` - The IDirectory itself.
  */
 export interface IDirectoryEvents extends IEvent {
+    /**
+     * Emitted when a key is set or deleted. As opposed to the
+     * {@link SharedDirectory}'s valueChanged event, this is emitted only on the {@link IDirectory} that directly
+     * contains the key.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `changed` - Information on the key that changed and its value prior to the change.
+     *
+     * - `local` - Whether the change originated from this client.
+     *
+     * - `target` - The {@link IDirectory} itself.
+     */
     (event: "containedValueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when a subdirectory is created.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `path` - The relative path to the subdirectory that is created.
+     * It is relative from the object which raises the event.
+     *
+     * - `local` - Whether the creation originated from the this client.
+     *
+     * - `target` - The {@link ISharedDirectory} itself.
+     */
     (event: "subDirectoryCreated", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when a subdirectory is deleted.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `path` - The relative path to the subdirectory that is deleted.
+     * It is relative from the object which raises the event.
+     *
+     * - `local` - Whether the delete originated from the this client.
+     *
+     * - `target` - The {@link ISharedDirectory} itself.
+     */
     (event: "subDirectoryDeleted", listener: (path: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when this sub directory is deleted.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `target` - The {@link IDirectory} itself.
+     */
     (event: "disposed", listener: (target: IEventThisPlaceHolder) => void): any;
 }
 /**
- * Interface describing a shared directory.
+ * Provides a hierarchical organization of map-like data structures as SubDirectories.
+ * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.
+ * SubDirectories can be retrieved for use as working directories.
  */
 export interface ISharedDirectory extends ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>, Omit<IDirectory, "on" | "once" | "off"> {
     [Symbol.iterator](): IterableIterator<[string, any]>;
     readonly [Symbol.toStringTag]: string;
 }
 /**
- * Type of "valueChanged" event parameter for SharedDirectory.
+ * Type of "valueChanged" event parameter for {@link ISharedDirectory}
  */
 export interface IDirectoryValueChanged extends IValueChanged {
     /**
@@ -253,69 +211,60 @@ export interface IDirectoryValueChanged extends IValueChanged {
     path: string;
 }
 /**
- * Events emitted in response to changes to the map data.
- *
- * @remarks
- *
- * The following is the list of events emitted.
- *
- * ### "valueChanged"
- *
- * The valueChanged event is emitted when a key is set or deleted.
- *
- * #### Listener signature
- *
- * ```typescript
- * (
- *     changed: IValueChanged,
- *     local: boolean,
- *     target: IEventThisPlaceHolder,
- * ) => void
- * ```
- * - `changed` - Information on the key that changed and its value prior to the change.
- *
- * - `local` - Whether the change originated from this client.
- *
- * - `target` - The map itself.
- *
- * ### "clear"
- *
- * The clear event is emitted when the map is cleared.
- *
- * #### Listener signature
- *
- * ```typescript
- * (local: boolean, target: IEventThisPlaceHolder) => void
- * ```
- * - `local` - Whether the clear originated from this client.
- *
- * - `target` - The map itself.
+ * Events emitted in response to changes to the {@link ISharedMap | map} data.
  */
 export interface ISharedMapEvents extends ISharedObjectEvents {
+    /**
+     * Emitted when a key is set or deleted.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `changed` - Information on the key that changed and its value prior to the change.
+     *
+     * - `local` - Whether the change originated from this client.
+     *
+     * - `target` - The {@link ISharedMap} itself.
+     */
     (event: "valueChanged", listener: (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void): any;
+    /**
+     * Emitted when the map is cleared.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `local` - Whether the clear originated from this client.
+     *
+     * - `target` - The {@link ISharedMap} itself.
+     */
     (event: "clear", listener: (local: boolean, target: IEventThisPlaceHolder) => void): any;
 }
 /**
- * Shared map interface
+ * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
+ * and retrieving values that JavaScript developers are accustomed to with the
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.
+ * However, the keys of a SharedMap must be strings, and the values must either be a JSON-serializable object or a
+ * {@link @fluidframework/shared-object-base#SharedObjectHandle}.
+ *
+ * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.
  */
 export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {
     /**
-     * Retrieves the given key from the map.
+     * Retrieves the given key from the map if it exists.
      * @param key - Key to retrieve from
      * @returns The stored value, or undefined if the key is not set
      */
     get<T = any>(key: string): T | undefined;
     /**
      * Sets the value stored at key to the provided value.
-     * @param key - Key to set at
+     * @param key - Key to set
      * @param value - Value to set
-     * @returns The ISharedMap itself
+     * @returns The {@link ISharedMap} itself
      */
     set<T = any>(key: string, value: T): this;
 }
 /**
  * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use
- * ISerializableValue.type to understand whether they're storing a Plain JS object, a SharedObject, or a value type.
+ * {@link ISerializableValue."type"} to understand whether they're storing a Plain JavaScript object,
+ * a {@link @fluidframework/shared-object-base#SharedObject}, or a value type.
  *
  * @remarks
  *
@@ -323,13 +272,17 @@ export interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string,
  * the _in-memory representation_ of the value instead).  An ISerializableValue is what gets passed to
  * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)
  * and ops (set).
+ *
  * If type is Plain, it must be a plain JS object that can survive a JSON.stringify/parse.  E.g. a URL object will
  * just get stringified to a URL string and not rehydrate as a URL object on the other side. It may contain members
  * that are ISerializedHandle (the serialized form of a handle).
+ *
  * If type is a value type then it must be amongst the types registered via registerValueType or we won't know how
  * to serialize/deserialize it (we rely on its factory via .load() and .store()).  Its value will be type-dependent.
  * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a
- * channel ID. This type is legacy and deprecated.
+ * channel ID.
+ *
+ * @deprecated This type is legacy and deprecated.
  */
 export interface ISerializableValue {
     /**
@@ -341,6 +294,9 @@ export interface ISerializableValue {
      */
     value: any;
 }
+/**
+ * Serialized {@link ISerializableValue} counterpart.
+ */
 export interface ISerializedValue {
     /**
      * A type annotation to help indicate how the value serializes.
@@ -348,6 +304,8 @@ export interface ISerializedValue {
     type: string;
     /**
      * String representation of the value.
+     *
+     * @remarks Will be undefined if the original value was undefined.
      */
     value: string | undefined;
 }

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAEhH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,cAAc,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IACxG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,iBAAiB,CAAC,IAAI,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC;IAEnD;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IAE5D;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhD;;;OAGG;IACH,cAAc,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAEzD;;;;OAIG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CACrE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IAC/D,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAC9B,OAAO,EAAE,sBAAsB,EAC/B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IACX,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CACvB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IACX,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CACvC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IACX,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IACX,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAC1B,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAC9B,aAAa,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,EACxD,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAGvC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IACzD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAC9B,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IAC5C,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CACvB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;IACjF;;;;OAIG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAEhH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,aAAa,EAAE,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAW,SAAQ,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,cAAc,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IACxG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAE1C;;;OAGG;IACH,iBAAiB,CAAC,IAAI,MAAM,CAAC;IAE7B;;;;;OAKG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC;IAEnD;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IAE5D;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAE7C;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhD;;;OAGG;IACH,cAAc,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAEzD;;;;OAIG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;CACrE;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IAC9D;;;;;;;;;;;;MAYE;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAC9B,OAAO,EAAE,sBAAsB,EAC/B,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;;;OAQG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CACvB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;;;;;;OAWG;IACH,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;;;;;;OAWG;IAEH,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC5C;;;;;;;;;;;;OAYG;IACH,CAAC,KAAK,EAAE,uBAAuB,EAAE,QAAQ,EAAE,CACvC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;;;;;;OAWG;IACH,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;;;;;;OAWG;IAEH,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,EAAE,CACrC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;IAEX;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAC1B,MAAM,EAAE,qBAAqB,KAC5B,IAAI,OAAE;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAC9B,aAAa,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,EACxD,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAGvC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;IACrD,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,aAAa;IACzD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,CAC9B,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;IAE5C;;;;;;;;OAQG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CACvB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,qBAAqB,KAAK,IAAI,OAAE;CAC/C;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC;IACjF;;;;OAIG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B"}

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Interface describing actions on a directory.\n *\n * @remarks\n * When used as a Map, operates on its keys.\n */\nexport interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {\n    /**\n     * The absolute path of the directory.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * Retrieves the value stored at the given key from the directory.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set at\n     * @param value - Value to set\n     * @returns The IDirectory itself\n     */\n    set<T = any>(key: string, value: T): this;\n\n    /**\n     * Get the number of sub directory within the directory.\n     * @returns The number of sub directory within a directory.\n     */\n    countSubDirectory?(): number;\n\n    /**\n     * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the\n     * same name already exists.\n     * @param subdirName - Name of the new child directory to create\n     * @returns The IDirectory child that was created or retrieved\n     */\n    createSubDirectory(subdirName: string): IDirectory;\n\n    /**\n     * Gets an IDirectory child of this IDirectory, if it exists.\n     * @param subdirName - Name of the child directory to get\n     * @returns The requested IDirectory\n     */\n    getSubDirectory(subdirName: string): IDirectory | undefined;\n\n    /**\n     * Checks whether this directory has a child directory with the given name.\n     * @param subdirName - Name of the child directory to check\n     * @returns True if it exists, false otherwise\n     */\n    hasSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.\n     * @param subdirName - Name of the child directory to delete\n     * @returns True if the IDirectory existed and was deleted, false if it did not exist\n     */\n    deleteSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Gets an iterator over the IDirectory children of this IDirectory.\n     * @returns The IDirectory iterator\n     */\n    subdirectories(): IterableIterator<[string, IDirectory]>;\n\n    /**\n     * Get an IDirectory within the directory, in order to use relative paths from that location.\n     * @param relativePath - Path of the IDirectory to get, relative to this IDirectory\n     * @returns The requested IDirectory\n     */\n    getWorkingDirectory(relativePath: string): IDirectory | undefined;\n}\n\n/**\n * Events emitted in response to changes to the directory data. These events only emit on the ISharedDirectory itself,\n * and not on subdirectories.\n *\n * @remarks\n *\n * The following is the list of events emitted.\n *\n * ### \"valueChanged\"\n *\n * The valueChanged event is emitted when a key is set or deleted.  This is emitted for any key in the ISharedDirectory\n * or any subdirectory.\n *\n * #### Listener signature\n *\n * ```typescript\n * (\n *     changed: IDirectoryValueChanged,\n *     local: boolean,\n *     target: IEventThisPlaceHolder,\n * ) => void\n * ```\n * - `changed` - Information on the key that changed, its value prior to the change, and the path to the key that\n *   changed.\n *\n * - `local` - Whether the change originated from this client.\n *\n * - `target` - The ISharedDirectory itself.\n *\n * ### \"clear\"\n *\n * The clear event is emitted when the ISharedDirectory is cleared.\n *\n * #### Listener signature\n *\n * ```typescript\n * (local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `local` - Whether the clear originated from this client.\n *\n * - `target` - The ISharedDirectory itself.\n *\n * ### \"subDirectoryCreated\"\n *\n * The subDirectoryCreated event is emitted when a subdirectory is created.\n *\n * #### Listener signature\n *\n * ```typescript\n * (path: string, local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `path` -  The relative path to the subdirectory that is created.\n *             It is relative from the object which raises the event.\n *\n * - `local` - Whether the create originated from the this client.\n *\n * - `target` - The ISharedDirectory itself.\n *\n * ###\"subDirectoryDeleted\"\n *\n * The subDirectoryDeleted event is emitted when a subdirectory is deleted.\n *\n * #### Listener signature\n *\n * ```typescript\n * (path: string, local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `path` - The relative path to the subdirectory that is deleted.\n *            It is relative from the object which raises the event.\n *\n * - `local` - Whether the delete originated from the this client.\n *\n * - `target` - The ISharedDirectory itself.\n */\nexport interface ISharedDirectoryEvents extends ISharedObjectEvents {\n    (event: \"valueChanged\", listener: (\n        changed: IDirectoryValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n *\n * @remarks\n *\n * The following is the list of events emitted.\n *\n * ### \"containedValueChanged\"\n *\n * The containedValueChanged event is emitted when a key is set or deleted.  As opposed to the SharedDirectory's\n * valueChanged event, this is emitted only on the IDirectory that directly contains the key.\n *\n * #### Listener signature\n *\n * ```typescript\n * (changed: IValueChanged, local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `changed` - Information on the key that changed and its value prior to the change.\n *\n * - `local` - Whether the change originated from this client.\n *\n * - `target` - The IDirectory itself.\n *\n * ### \"subDirectoryCreated\"\n *\n * The subDirectoryCreated event is emitted when a subdirectory is created.\n *\n * #### Listener signature\n *\n * ```typescript\n * (path: string, local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `path` - The relative path to the subdirectory that is created.\n *            It is relative from the object which raises the event.\n *\n * - `local` - Whether the creation originated from the this client.\n *\n * - `target` - The ISharedDirectory itself.\n *\n * ### \"subDirectoryDeleted\"\n *\n * The subDirectoryDeleted event is emitted when a subdirectory is deleted.\n *\n * #### Listener signature\n *\n * ```typescript\n * (path: string, local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `path` - The relative path to the subdirectory that is deleted.\n *            It is relative from the object which raises the event.\n *\n * - `local` - Whether the delete originated from the this client.\n *\n * - `target` - The ISharedDirectory itself.\n *\n * ### \"disposed\"\n *\n * The dispose event is emitted when this sub directory is deleted.\n *\n * #### Listener signature\n *\n * ```typescript\n * (local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n *\n * - `target` - The IDirectory itself.\n */\nexport interface IDirectoryEvents extends IEvent {\n    (event: \"containedValueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n    (event: \"disposed\", listener: (\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Interface describing a shared directory.\n */\nexport interface ISharedDirectory extends\n    ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,\n    Omit<IDirectory, \"on\" | \"once\" | \"off\"> {\n    // The Omit type excludes symbols, which we don't want to exclude.  Adding them back here manually.\n    // https://github.com/microsoft/TypeScript/issues/31671\n    [Symbol.iterator](): IterableIterator<[string, any]>;\n    readonly [Symbol.toStringTag]: string;\n}\n\n/**\n * Type of \"valueChanged\" event parameter for SharedDirectory.\n */\nexport interface IDirectoryValueChanged extends IValueChanged {\n    /**\n     * The absolute path to the IDirectory storing the key which changed.\n     */\n    path: string;\n}\n\n/**\n * Events emitted in response to changes to the map data.\n *\n * @remarks\n *\n * The following is the list of events emitted.\n *\n * ### \"valueChanged\"\n *\n * The valueChanged event is emitted when a key is set or deleted.\n *\n * #### Listener signature\n *\n * ```typescript\n * (\n *     changed: IValueChanged,\n *     local: boolean,\n *     target: IEventThisPlaceHolder,\n * ) => void\n * ```\n * - `changed` - Information on the key that changed and its value prior to the change.\n *\n * - `local` - Whether the change originated from this client.\n *\n * - `target` - The map itself.\n *\n * ### \"clear\"\n *\n * The clear event is emitted when the map is cleared.\n *\n * #### Listener signature\n *\n * ```typescript\n * (local: boolean, target: IEventThisPlaceHolder) => void\n * ```\n * - `local` - Whether the clear originated from this client.\n *\n * - `target` - The map itself.\n */\nexport interface ISharedMapEvents extends ISharedObjectEvents {\n    (event: \"valueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * Shared map interface\n */\nexport interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {\n    /**\n     * Retrieves the given key from the map.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set at\n     * @param value - Value to set\n     * @returns The ISharedMap itself\n     */\n    set<T = any>(key: string, value: T): this;\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * ISerializableValue.type to understand whether they're storing a Plain JS object, a SharedObject, or a value type.\n *\n * @remarks\n *\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead).  An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n * If type is Plain, it must be a plain JS object that can survive a JSON.stringify/parse.  E.g. a URL object will\n * just get stringified to a URL string and not rehydrate as a URL object on the other side. It may contain members\n * that are ISerializedHandle (the serialized form of a handle).\n * If type is a value type then it must be amongst the types registered via registerValueType or we won't know how\n * to serialize/deserialize it (we rely on its factory via .load() and .store()).  Its value will be type-dependent.\n * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a\n * channel ID. This type is legacy and deprecated.\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     */\n    value: string | undefined;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { ISharedObject, ISharedObjectEvents } from \"@fluidframework/shared-object-base\";\nimport { IDisposable, IEvent, IEventProvider, IEventThisPlaceHolder } from \"@fluidframework/common-definitions\";\n\n/**\n * Type of \"valueChanged\" event parameter.\n */\nexport interface IValueChanged {\n    /**\n     * The key storing the value that changed.\n     */\n    key: string;\n\n    /**\n     * The value that was stored at the key prior to the change.\n     */\n    previousValue: any;\n}\n\n/**\n * Interface describing actions on a directory.\n *\n * @remarks\n * When used as a Map, operates on its keys.\n */\nexport interface IDirectory extends Map<string, any>, IEventProvider<IDirectoryEvents>, Partial<IDisposable> {\n    /**\n     * The absolute path of the directory.\n     */\n    readonly absolutePath: string;\n\n    /**\n     * Retrieves the value stored at the given key from the directory.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set at\n     * @param value - Value to set\n     * @returns The IDirectory itself\n     */\n    set<T = any>(key: string, value: T): this;\n\n    /**\n     * Get the number of sub directory within the directory.\n     * @returns The number of sub directory within a directory.\n     */\n    countSubDirectory?(): number;\n\n    /**\n     * Creates an IDirectory child of this IDirectory, or retrieves the existing IDirectory child if one with the\n     * same name already exists.\n     * @param subdirName - Name of the new child directory to create\n     * @returns The IDirectory child that was created or retrieved\n     */\n    createSubDirectory(subdirName: string): IDirectory;\n\n    /**\n     * Gets an IDirectory child of this IDirectory, if it exists.\n     * @param subdirName - Name of the child directory to get\n     * @returns The requested IDirectory\n     */\n    getSubDirectory(subdirName: string): IDirectory | undefined;\n\n    /**\n     * Checks whether this directory has a child directory with the given name.\n     * @param subdirName - Name of the child directory to check\n     * @returns True if it exists, false otherwise\n     */\n    hasSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Deletes an IDirectory child of this IDirectory, if it exists, along with all descendent keys and directories.\n     * @param subdirName - Name of the child directory to delete\n     * @returns True if the IDirectory existed and was deleted, false if it did not exist\n     */\n    deleteSubDirectory(subdirName: string): boolean;\n\n    /**\n     * Gets an iterator over the IDirectory children of this IDirectory.\n     * @returns The IDirectory iterator\n     */\n    subdirectories(): IterableIterator<[string, IDirectory]>;\n\n    /**\n     * Get an IDirectory within the directory, in order to use relative paths from that location.\n     * @param relativePath - Path of the IDirectory to get, relative to this IDirectory\n     * @returns The requested IDirectory\n     */\n    getWorkingDirectory(relativePath: string): IDirectory | undefined;\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n * These events only emit on the {@link ISharedDirectory} itself, and not on subdirectories.\n */\nexport interface ISharedDirectoryEvents extends ISharedObjectEvents {\n     /**\n     * Emitted when a key is set or deleted. This is emitted for any key in the {@link ISharedDirectory} or any\n     * subdirectory.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed, its value prior to the change, and the path to the\n     * key that changed.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IDirectoryValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when the {@link ISharedDirectory} is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the create originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Events emitted in response to changes to the directory data.\n */\nexport interface IDirectoryEvents extends IEvent {\n    /**\n     * Emitted when a key is set or deleted. As opposed to the\n     * {@link SharedDirectory}'s valueChanged event, this is emitted only on the {@link IDirectory} that directly\n     * contains the key.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"containedValueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is created.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is created.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the creation originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    (event: \"subDirectoryCreated\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when a subdirectory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `path` - The relative path to the subdirectory that is deleted.\n     * It is relative from the object which raises the event.\n     *\n     * - `local` - Whether the delete originated from the this client.\n     *\n     * - `target` - The {@link ISharedDirectory} itself.\n     */\n    // eslint-disable-next-line @typescript-eslint/unified-signatures\n    (event: \"subDirectoryDeleted\", listener: (\n        path: string,\n        local: boolean,\n        target: IEventThisPlaceHolder,\n    ) => void);\n\n    /**\n     * Emitted when this sub directory is deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `target` - The {@link IDirectory} itself.\n     */\n    (event: \"disposed\", listener: (\n        target: IEventThisPlaceHolder,\n    ) => void);\n}\n\n/**\n * Provides a hierarchical organization of map-like data structures as SubDirectories.\n * The values stored within can be accessed like a map, and the hierarchy can be navigated using path syntax.\n * SubDirectories can be retrieved for use as working directories.\n */\nexport interface ISharedDirectory extends\n    ISharedObject<ISharedDirectoryEvents & IDirectoryEvents>,\n    Omit<IDirectory, \"on\" | \"once\" | \"off\"> {\n    // The Omit type excludes symbols, which we don't want to exclude.  Adding them back here manually.\n    // https://github.com/microsoft/TypeScript/issues/31671\n    [Symbol.iterator](): IterableIterator<[string, any]>;\n    readonly [Symbol.toStringTag]: string;\n}\n\n/**\n * Type of \"valueChanged\" event parameter for {@link ISharedDirectory}\n */\nexport interface IDirectoryValueChanged extends IValueChanged {\n    /**\n     * The absolute path to the IDirectory storing the key which changed.\n     */\n    path: string;\n}\n\n/**\n * Events emitted in response to changes to the {@link ISharedMap | map} data.\n */\nexport interface ISharedMapEvents extends ISharedObjectEvents {\n    /**\n     * Emitted when a key is set or deleted.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `changed` - Information on the key that changed and its value prior to the change.\n     *\n     * - `local` - Whether the change originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"valueChanged\", listener: (\n        changed: IValueChanged,\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n\n    /**\n     * Emitted when the map is cleared.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `local` - Whether the clear originated from this client.\n     *\n     * - `target` - The {@link ISharedMap} itself.\n     */\n    (event: \"clear\", listener: (\n        local: boolean,\n        target: IEventThisPlaceHolder) => void);\n}\n\n/**\n * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting\n * and retrieving values that JavaScript developers are accustomed to with the\n * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.\n * However, the keys of a SharedMap must be strings, and the values must either be a JSON-serializable object or a\n * {@link @fluidframework/shared-object-base#SharedObjectHandle}.\n *\n * For more information, including example usages, see {@link https://fluidframework.com/docs/data-structures/map/}.\n */\nexport interface ISharedMap extends ISharedObject<ISharedMapEvents>, Map<string, any> {\n    /**\n     * Retrieves the given key from the map if it exists.\n     * @param key - Key to retrieve from\n     * @returns The stored value, or undefined if the key is not set\n     */\n    get<T = any>(key: string): T | undefined;\n\n    /**\n     * Sets the value stored at key to the provided value.\n     * @param key - Key to set\n     * @param value - Value to set\n     * @returns The {@link ISharedMap} itself\n     */\n    set<T = any>(key: string, value: T): this;\n}\n\n/**\n * The _ready-for-serialization_ format of values contained in DDS contents. This allows us to use\n * {@link ISerializableValue.\"type\"} to understand whether they're storing a Plain JavaScript object,\n * a {@link @fluidframework/shared-object-base#SharedObject}, or a value type.\n *\n * @remarks\n *\n * Note that the in-memory equivalent of ISerializableValue is ILocalValue (similarly holding a type, but with\n * the _in-memory representation_ of the value instead).  An ISerializableValue is what gets passed to\n * JSON.stringify and comes out of JSON.parse. This format is used both for snapshots (loadCore/populate)\n * and ops (set).\n *\n * If type is Plain, it must be a plain JS object that can survive a JSON.stringify/parse.  E.g. a URL object will\n * just get stringified to a URL string and not rehydrate as a URL object on the other side. It may contain members\n * that are ISerializedHandle (the serialized form of a handle).\n *\n * If type is a value type then it must be amongst the types registered via registerValueType or we won't know how\n * to serialize/deserialize it (we rely on its factory via .load() and .store()).  Its value will be type-dependent.\n * If type is Shared, then the in-memory value will just be a reference to the SharedObject.  Its value will be a\n * channel ID.\n *\n * @deprecated This type is legacy and deprecated.\n */\nexport interface ISerializableValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * The JSONable representation of the value.\n     */\n    value: any;\n}\n\n/**\n * Serialized {@link ISerializableValue} counterpart.\n */\nexport interface ISerializedValue {\n    /**\n     * A type annotation to help indicate how the value serializes.\n     */\n    type: string;\n\n    /**\n     * String representation of the value.\n     *\n     * @remarks Will be undefined if the original value was undefined.\n     */\n    value: string | undefined;\n}\n"]}

package/lib/localValues.d.ts

@@ -6,7 +6,7 @@ import { IFluidHandle } from "@fluidframework/core-interfaces";
 import { IFluidSerializer } from "@fluidframework/shared-object-base";
 import { ISerializableValue, ISerializedValue } from "./interfaces";
 /**
- * A local value to be stored in a container type DDS.
+ * A local value to be stored in a container type Distributed Data Store (DDS).
  */
 export interface ILocalValue {
     /**
@@ -46,8 +46,8 @@ export declare class PlainLocalValue implements ILocalValue {
     makeSerialized(serializer: IFluidSerializer, bind: IFluidHandle): ISerializedValue;
 }
 /**
- * A LocalValueMaker enables a container type DDS to produce and store local values with minimal awareness of how
- * those objects are stored, serialized, and deserialized.
+ * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local
+ * values with minimal awareness of how those objects are stored, serialized, and deserialized.
  */
 export declare class LocalValueMaker {
     private readonly serializer;

package/lib/localValues.js

@@ -41,8 +41,8 @@ export class PlainLocalValue {
     }
 }
 /**
- * A LocalValueMaker enables a container type DDS to produce and store local values with minimal awareness of how
- * those objects are stored, serialized, and deserialized.
+ * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local
+ * values with minimal awareness of how those objects are stored, serialized, and deserialized.
  */
 export class LocalValueMaker {
     /**

package/lib/localValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"localValues.js","sourceRoot":"","sources":["../src/localValues.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGH,YAAY,EACZ,gBAAgB,EAChB,SAAS,GACZ,MAAM,oCAAoC,CAAC;AAgC5C,MAAM,UAAU,gBAAgB,CAC5B,UAAuB,EACvB,UAA4B,EAC5B,IAAkB;IAClB,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1D,OAAO;QACH,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;KAChD,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IACxB;;;OAGG;IACH,YAA4B,KAAU;QAAV,UAAK,GAAL,KAAK,CAAK;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,cAAc,CACjB,UAA4B,EAC5B,IAAkB;QAElB,2FAA2F;QAC3F,oBAAoB;QACpB,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAE7D,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK;SACR,CAAC;IACN,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IACxB;;;OAGG;IACH,YAA6B,UAA4B;QAA5B,eAAU,GAAV,UAAU,CAAkB;IACzD,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,YAAgC;QACpD,2CAA2C;QAC3C,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACnD,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAsB;gBAC9B,IAAI,EAAE,kBAAkB;gBACxB,GAAG,EAAE,YAAY,CAAC,KAAe;aACpC,CAAC;YACF,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC;SAC/B;QAED,MAAM,eAAe,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,OAAO,IAAI,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,KAAU;QAC1B,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidSerializer,\n    ISerializedHandle,\n    parseHandles,\n    serializeHandles,\n    ValueType,\n} from \"@fluidframework/shared-object-base\";\nimport {\n    ISerializableValue,\n    ISerializedValue,\n} from \"./interfaces\";\n\n/**\n * A local value to be stored in a container type DDS.\n */\nexport interface ILocalValue {\n    /**\n     * Type indicator of the value stored within.\n     */\n    readonly type: string;\n\n    /**\n     * The in-memory value stored within.\n     */\n    readonly value: any;\n\n    /**\n     * Retrieve the serialized form of the value stored within.\n     * @param serializer - Data store runtime's serializer\n     * @param bind - Container type's handle\n     * @returns The serialized form of the contained value\n     */\n    makeSerialized(\n        serializer: IFluidSerializer,\n        bind: IFluidHandle,\n    ): ISerializedValue;\n}\n\nexport function makeSerializable(\n    localValue: ILocalValue,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle): ISerializableValue {\n    const value = localValue.makeSerialized(serializer, bind);\n    return {\n        type: value.type,\n        value: value.value && JSON.parse(value.value),\n    };\n}\n\n/**\n * Manages a contained plain value.  May also contain shared object handles.\n */\nexport class PlainLocalValue implements ILocalValue {\n    /**\n     * Create a new PlainLocalValue.\n     * @param value - The value to store, which may contain shared object handles\n     */\n    constructor(public readonly value: any) {\n    }\n\n    /**\n     * {@inheritDoc ILocalValue.\"type\"}\n     */\n    public get type(): string {\n        return ValueType[ValueType.Plain];\n    }\n\n    /**\n     * {@inheritDoc ILocalValue.makeSerialized}\n     */\n    public makeSerialized(\n        serializer: IFluidSerializer,\n        bind: IFluidHandle,\n    ): ISerializedValue {\n        // Stringify to convert to the serialized handle values - and then parse in order to create\n        // a POJO for the op\n        const value = serializeHandles(this.value, serializer, bind);\n\n        return {\n            type: this.type,\n            value,\n        };\n    }\n}\n\n/**\n * A LocalValueMaker enables a container type DDS to produce and store local values with minimal awareness of how\n * those objects are stored, serialized, and deserialized.\n */\nexport class LocalValueMaker {\n    /**\n     * Create a new LocalValueMaker.\n     * @param serializer - The serializer to serialize / parse handles.\n     */\n    constructor(private readonly serializer: IFluidSerializer) {\n    }\n\n    /**\n     * Create a new local value from an incoming serialized value.\n     * @param serializable - The serializable value to make local\n     */\n    public fromSerializable(serializable: ISerializableValue): ILocalValue {\n        // Migrate from old shared value to handles\n        if (serializable.type === ValueType[ValueType.Shared]) {\n            serializable.type = ValueType[ValueType.Plain];\n            const handle: ISerializedHandle = {\n                type: \"__fluid_handle__\",\n                url: serializable.value as string,\n            };\n            serializable.value = handle;\n        }\n\n        const translatedValue = parseHandles(serializable.value, this.serializer);\n\n        return new PlainLocalValue(translatedValue);\n    }\n\n    /**\n     * Create a new local value containing a given plain object.\n     * @param value - The value to store\n     * @returns An ILocalValue containing the value\n     */\n    public fromInMemory(value: any): ILocalValue {\n        return new PlainLocalValue(value);\n    }\n}\n"]}
+{"version":3,"file":"localValues.js","sourceRoot":"","sources":["../src/localValues.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAGH,YAAY,EACZ,gBAAgB,EAChB,SAAS,GACZ,MAAM,oCAAoC,CAAC;AAgC5C,MAAM,UAAU,gBAAgB,CAC5B,UAAuB,EACvB,UAA4B,EAC5B,IAAkB;IAClB,MAAM,KAAK,GAAG,UAAU,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC1D,OAAO;QACH,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC;KAChD,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IACxB;;;OAGG;IACH,YAA4B,KAAU;QAAV,UAAK,GAAL,KAAK,CAAK;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,cAAc,CACjB,UAA4B,EAC5B,IAAkB;QAElB,2FAA2F;QAC3F,oBAAoB;QACpB,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAE7D,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK;SACR,CAAC;IACN,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,OAAO,eAAe;IACxB;;;OAGG;IACH,YAA6B,UAA4B;QAA5B,eAAU,GAAV,UAAU,CAAkB;IACzD,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,YAAgC;QACpD,2CAA2C;QAC3C,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE;YACnD,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAsB;gBAC9B,IAAI,EAAE,kBAAkB;gBACxB,GAAG,EAAE,YAAY,CAAC,KAAe;aACpC,CAAC;YACF,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC;SAC/B;QAED,MAAM,eAAe,GAAG,YAAY,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAE1E,OAAO,IAAI,eAAe,CAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,KAAU;QAC1B,OAAO,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport {\n    IFluidSerializer,\n    ISerializedHandle,\n    parseHandles,\n    serializeHandles,\n    ValueType,\n} from \"@fluidframework/shared-object-base\";\nimport {\n    ISerializableValue,\n    ISerializedValue,\n} from \"./interfaces\";\n\n/**\n * A local value to be stored in a container type Distributed Data Store (DDS).\n */\nexport interface ILocalValue {\n    /**\n     * Type indicator of the value stored within.\n     */\n    readonly type: string;\n\n    /**\n     * The in-memory value stored within.\n     */\n    readonly value: any;\n\n    /**\n     * Retrieve the serialized form of the value stored within.\n     * @param serializer - Data store runtime's serializer\n     * @param bind - Container type's handle\n     * @returns The serialized form of the contained value\n     */\n    makeSerialized(\n        serializer: IFluidSerializer,\n        bind: IFluidHandle,\n    ): ISerializedValue;\n}\n\nexport function makeSerializable(\n    localValue: ILocalValue,\n    serializer: IFluidSerializer,\n    bind: IFluidHandle): ISerializableValue {\n    const value = localValue.makeSerialized(serializer, bind);\n    return {\n        type: value.type,\n        value: value.value && JSON.parse(value.value),\n    };\n}\n\n/**\n * Manages a contained plain value.  May also contain shared object handles.\n */\nexport class PlainLocalValue implements ILocalValue {\n    /**\n     * Create a new PlainLocalValue.\n     * @param value - The value to store, which may contain shared object handles\n     */\n    constructor(public readonly value: any) {\n    }\n\n    /**\n     * {@inheritDoc ILocalValue.\"type\"}\n     */\n    public get type(): string {\n        return ValueType[ValueType.Plain];\n    }\n\n    /**\n     * {@inheritDoc ILocalValue.makeSerialized}\n     */\n    public makeSerialized(\n        serializer: IFluidSerializer,\n        bind: IFluidHandle,\n    ): ISerializedValue {\n        // Stringify to convert to the serialized handle values - and then parse in order to create\n        // a POJO for the op\n        const value = serializeHandles(this.value, serializer, bind);\n\n        return {\n            type: this.type,\n            value,\n        };\n    }\n}\n\n/**\n * Enables a container type {@link https://fluidframework.com/docs/build/dds/ | DDS} to produce and store local\n * values with minimal awareness of how those objects are stored, serialized, and deserialized.\n */\nexport class LocalValueMaker {\n    /**\n     * Create a new LocalValueMaker.\n     * @param serializer - The serializer to serialize / parse handles.\n     */\n    constructor(private readonly serializer: IFluidSerializer) {\n    }\n\n    /**\n     * Create a new local value from an incoming serialized value.\n     * @param serializable - The serializable value to make local\n     */\n    public fromSerializable(serializable: ISerializableValue): ILocalValue {\n        // Migrate from old shared value to handles\n        if (serializable.type === ValueType[ValueType.Shared]) {\n            serializable.type = ValueType[ValueType.Plain];\n            const handle: ISerializedHandle = {\n                type: \"__fluid_handle__\",\n                url: serializable.value as string,\n            };\n            serializable.value = handle;\n        }\n\n        const translatedValue = parseHandles(serializable.value, this.serializer);\n\n        return new PlainLocalValue(translatedValue);\n    }\n\n    /**\n     * Create a new local value containing a given plain object.\n     * @param value - The value to store\n     * @returns An ILocalValue containing the value\n     */\n    public fromInMemory(value: any): ILocalValue {\n        return new PlainLocalValue(value);\n    }\n}\n"]}

package/lib/map.d.ts

@@ -8,7 +8,8 @@ import { ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtim
 import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
 import { ISharedMap, ISharedMapEvents } from "./interfaces";
 /**
- * The factory that defines the map.
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
+ *
  * @sealed
  */
 export declare class MapFactory implements IChannelFactory {
@@ -38,10 +39,7 @@ export declare class MapFactory implements IChannelFactory {
     create(runtime: IFluidDataStoreRuntime, id: string): ISharedMap;
 }
 /**
- * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
- * and retrieving values that JavaScript developers are accustomed to with the
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.
- * However, the keys of a SharedMap must be strings.
+ * {@inheritDoc ISharedMap}
  */
 export declare class SharedMap extends SharedObject<ISharedMapEvents> implements ISharedMap {
     /**

package/lib/map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../src/map.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAE/F,OAAO,EACH,gBAAgB,EAChB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,UAAU,EACV,gBAAgB,EACnB,MAAM,cAAc,CAAC;AAWtB;;;GAGG;AACH,qBAAa,UAAW,YAAW,eAAe;IAC9C;;OAEG;IACH,gBAAuB,IAAI,2CAA2C;IAEtE;;OAEG;IACH,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAOxD;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,UAAU;CAMzE;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,YAAY,CAAC,gBAAgB,CAAE,YAAW,UAAU;IAC/E;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS;IAI7E;;;OAGG;WACW,UAAU,IAAI,eAAe;IAI3C;;OAEG;IACH,SAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAe;IAE3D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAY;IAEnC;;;;;;OAMG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAYlC;;;OAGG;IACI,IAAI,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAIjD;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAItC;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAI3D;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;;OAGG;IACI,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,IAAI;IAI1F;;OAEG;IACI,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI/C;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAKzC;;;;OAIG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACH,SAAS,CAAC,aAAa,CACnB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAsExB;;;OAGG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAcxD;;;OAGG;IACH,SAAS,CAAC,YAAY;IAEtB;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAK/C;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAMlG;;;MAGE;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;CAG3D"}
+{"version":3,"file":"map.d.ts","sourceRoot":"","sources":["../src/map.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,yBAAyB,EAAe,MAAM,sCAAsC,CAAC;AAC9F,OAAO,EACH,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AAE/F,OAAO,EACH,gBAAgB,EAChB,YAAY,EACf,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,UAAU,EACV,gBAAgB,EACnB,MAAM,cAAc,CAAC;AAWtB;;;;GAIG;AACH,qBAAa,UAAW,YAAW,eAAe;IAC9C;;OAEG;IACH,gBAAuB,IAAI,2CAA2C;IAEtE;;OAEG;IACH,gBAAuB,UAAU,EAAE,kBAAkB,CAInD;IAEF;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;OAEG;IACH,IAAW,UAAU,uBAEpB;IAED;;OAEG;IACU,IAAI,CACb,OAAO,EAAE,sBAAsB,EAC/B,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAOxD;;OAEG;IACI,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,UAAU;CAMzE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAY,CAAC,gBAAgB,CAAE,YAAW,UAAU;IAC/E;;;;;;;;;;;;OAYG;WACW,MAAM,CAAC,OAAO,EAAE,sBAAsB,EAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS;IAI7E;;;OAGG;WACW,UAAU,IAAI,eAAe;IAI3C;;OAEG;IACH,SAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAe;IAE3D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAY;IAEnC;;;;;;OAMG;gBAEC,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB;IAYlC;;;OAGG;IACI,IAAI,IAAI,gBAAgB,CAAC,MAAM,CAAC;IAIvC;;;OAGG;IACI,OAAO,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAIjD;;;OAGG;IACI,MAAM,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAItC;;;OAGG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAI3D;;OAEG;IACH,IAAW,IAAI,WAEd;IAED;;;OAGG;IACI,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,IAAI;IAI1F;;OAEG;IACI,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAI/C;;;;OAIG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIhC;;OAEG;IACI,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAKzC;;;;OAIG;IACI,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACH,SAAS,CAAC,aAAa,CACnB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,GACrC,qBAAqB;IAsExB;;;OAGG;cACa,QAAQ,CAAC,OAAO,EAAE,sBAAsB;IAcxD;;;OAGG;IACH,SAAS,CAAC,YAAY;IAEtB;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;IAI7D;;;OAGG;IACH,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,GAAG,GAAG,OAAO;IAI/C;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO;IAMlG;;;MAGE;IACF,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,OAAO;CAG5D"}

package/lib/map.js

@@ -11,7 +11,8 @@ import { MapKernel } from "./mapKernel";
 import { pkgVersion } from "./packageVersion";
 const snapshotFileName = "header";
 /**
- * The factory that defines the map.
+ * {@link @fluidframework/datastore-definitions#IChannelFactory} for {@link SharedMap}.
+ *
  * @sealed
  */
 export class MapFactory {
@@ -57,10 +58,7 @@ MapFactory.Attributes = {
     packageVersion: pkgVersion,
 };
 /**
- * The SharedMap distributed data structure can be used to store key-value pairs. It provides the same API for setting
- * and retrieving values that JavaScript developers are accustomed to with the
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map | Map} built-in object.
- * However, the keys of a SharedMap must be strings.
+ * {@inheritDoc ISharedMap}
  */
 export class SharedMap extends SharedObject {
     /**
@@ -278,8 +276,7 @@ export class SharedMap extends SharedObject {
      * @internal
      */
     applyStashedOp(content) {
-        this.kernel.tryProcessMessage(content, false, undefined);
-        return this.kernel.tryGetStashedOpLocalMetadata(content);
+        return this.kernel.tryApplyStashedOp(content);
     }
     /**
      * {@inheritDoc @fluidframework/shared-object-base#SharedObject.processCore}