@fluidframework/map 2.0.0-internal.6.3.3 → 2.0.0-internal.7.0.0

package/lib/directory.js

@@ -68,6 +68,7 @@ DirectoryFactory.Attributes = {
  * {@inheritDoc ISharedDirectory}
  *
  * @example
+ *
  * ```typescript
  * mySharedDirectory.createSubDirectory("a").createSubDirectory("b").createSubDirectory("c").set("foo", val1);
  * const mySubDir = mySharedDirectory.getWorkingDirectory("/a/b/c");
@@ -77,6 +78,30 @@ DirectoryFactory.Attributes = {
  * @sealed
  */
 export class SharedDirectory extends SharedObject {
+    /**
+     * Create a new shared directory
+     *
+     * @param runtime - Data store runtime the new shared directory belongs to
+     * @param id - Optional name of the shared directory
+     * @returns Newly create shared directory (but not attached yet)
+     */
+    static create(runtime, id) {
+        return runtime.createChannel(id, DirectoryFactory.Type);
+    }
+    /**
+     * Get a factory for SharedDirectory to register with the data store.
+     *
+     * @returns A factory that creates and load SharedDirectory
+     */
+    static getFactory() {
+        return new DirectoryFactory();
+    }
+    /**
+     * {@inheritDoc IDirectory.absolutePath}
+     */
+    get absolutePath() {
+        return this.root.absolutePath;
+    }
     /**
      * Constructs a new shared directory. If the object is non-local an id and service interfaces will
      * be provided.
@@ -111,30 +136,6 @@ export class SharedDirectory extends SharedObject {
             this.emit("subDirectoryDeleted", relativePath, local, this);
         });
     }
-    /**
-     * Create a new shared directory
-     *
-     * @param runtime - Data store runtime the new shared directory belongs to
-     * @param id - Optional name of the shared directory
-     * @returns Newly create shared directory (but not attached yet)
-     */
-    static create(runtime, id) {
-        return runtime.createChannel(id, DirectoryFactory.Type);
-    }
-    /**
-     * Get a factory for SharedDirectory to register with the data store.
-     *
-     * @returns A factory that creates and load SharedDirectory
-     */
-    static getFactory() {
-        return new DirectoryFactory();
-    }
-    /**
-     * {@inheritDoc IDirectory.absolutePath}
-     */
-    get absolutePath() {
-        return this.root.absolutePath;
-    }
     /**
      * {@inheritDoc IDirectory.get}
      */
@@ -420,7 +421,7 @@ export class SharedDirectory extends SharedObject {
     /**
      * This checks if there is pending delete op for local delete for a any subdir in the relative path.
      * @param relativePath - path of sub directory.
-     * @returns - true if there is pending delete.
+     * @returns `true` if there is pending delete, `false` otherwise.
      */
     isSubDirectoryDeletePending(relativePath) {
         const absolutePath = this.makeAbsolute(relativePath);
@@ -823,7 +824,7 @@ class SubDirectory extends TypedEventEmitter {
     }
     /**
      * @returns A sequenceNumber which should be used for local changes.
-     * @remarks - While detached, 0 is used rather than -1 to represent a change which should be universally known (as opposed to known
+     * @remarks While detached, 0 is used rather than -1 to represent a change which should be universally known (as opposed to known
      * only by the local client). This ensures that if the directory is later attached, none of its data needs to be updated (the values
      * last set while detached will now be known to any new client, until they are changed).
      * TODO: Convert these conventions to named constants. The semantics used here match those for merge-tree.
@@ -884,7 +885,7 @@ class SubDirectory extends TypedEventEmitter {
     /**
      * This checks if there is pending delete op for local delete for a given child subdirectory.
      * @param subDirName - directory name.
-     * @returns - true if there is pending delete.
+     * @returns true if there is pending delete.
      */
     isSubDirectoryDeletePending(subDirName) {
         if (this.pendingDeleteSubDirectoriesTracker.has(subDirName)) {
@@ -1668,7 +1669,7 @@ class SubDirectory extends TypedEventEmitter {
      * @param local - Whether the message originated from the local client
      * @param seq - Sequence number at which this directory is created
      * @param clientId - Id of client which created this directory.
-     * @returns - True if is newly created, false if it already existed.
+     * @returns True if is newly created, false if it already existed.
      */
     createSubDirectoryCore(subdirName, local, seq, clientId) {
         const subdir = this._subdirectories.get(subdirName);