summaryrefslogtreecommitdiff
path: root/std/testing/_diff.ts
diff options
context:
space:
mode:
authorWilliam Perron <hey@wperron.io>2020-11-19 21:59:45 -0500
committerGitHub <noreply@github.com>2020-11-19 21:59:45 -0500
commit8a6a2a50f7ee17deadf8b7de5761c8f156885584 (patch)
tree7ed87bc916a12b9b58765b4ba6d64fdfd43e7a44 /std/testing/_diff.ts
parente582796f42b96a940cba757a8a08573bc61aca0c (diff)
docs(std): add missing jsdoc comments to exported functions (#8442)
includes: - http/file_server.ts - testing/_diff.ts - testing/asserts.ts Relates to #7487
Diffstat (limited to 'std/testing/_diff.ts')
-rw-r--r--std/testing/_diff.ts5
1 files changed, 5 insertions, 0 deletions
diff --git a/std/testing/_diff.ts b/std/testing/_diff.ts
index 5c84e891f..e6f631002 100644
--- a/std/testing/_diff.ts
+++ b/std/testing/_diff.ts
@@ -36,6 +36,11 @@ function createCommon<T>(A: T[], B: T[], reverse?: boolean): T[] {
return common;
}
+/**
+ * Renders the differences between the actual and expected values
+ * @param A Actual value
+ * @param B Expected value
+ */
export function diff<T>(A: T[], B: T[]): Array<DiffResult<T>> {
const prefixCommon = createCommon(A, B);
const suffixCommon = createCommon(