backend-common: clarify responsiblity of readTree directory deletion

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
backstage · Dec 22, 2021 · 2f6d8ec · 2f6d8ec
1 parent d4d5416
commit 2f6d8ec
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.changeset/hip-doors-joke.md b/.changeset/hip-doors-joke.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Updated the `ReadTreeResponse` documentation to clarify that the caller of `dir()` is responsible for removing the directory after use.
diff --git a/packages/backend-common/src/reading/types.ts b/packages/backend-common/src/reading/types.ts
@@ -222,6 +222,8 @@ export type ReadTreeResponse = {
   /**
    * Extracts the tree response into a directory and returns the path of the
    * directory.
+   *
+   * **NOTE**: It is the responsibility of the caller to remove the directory after use.
    */
   dir(options?: ReadTreeResponseDirOptions): Promise<string>;