From 2f6d8ec3b6bd3dd06199eb8f7d443346c71c6c82 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Wed, 22 Dec 2021 15:05:24 +0100 Subject: [PATCH] backend-common: clarify responsiblity of readTree directory deletion Signed-off-by: Patrik Oldsberg --- .changeset/hip-doors-joke.md | 5 +++++ packages/backend-common/src/reading/types.ts | 2 ++ 2 files changed, 7 insertions(+) create mode 100644 .changeset/hip-doors-joke.md diff --git a/.changeset/hip-doors-joke.md b/.changeset/hip-doors-joke.md new file mode 100644 index 0000000000..8757d0b2ee --- /dev/null +++ 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 index 16edf81ba6..46be7aa1b6 100644 --- 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;