Skip to content

Commit d7ddca4

Browse files
committed
Fix comment on expectedHash
1 parent 8780507 commit d7ddca4

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

packages/artifact/src/internal/shared/interfaces.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,9 @@ export interface DownloadArtifactOptions {
108108
path?: string
109109

110110
/**
111-
* The hash that was computed for the artifact during upload. Don't provide this unless you want to verify the hash.
112-
* If the hash doesn't match, the download will fail.
111+
* The hash that was computed for the artifact during upload. If provided, the outcome of the download
112+
* will provide a digestMismatch property indicating whether the hash of the downloaded artifact
113+
* matches the expected hash.
113114
*/
114115
expectedHash?: string
115116
}

0 commit comments

Comments
 (0)