Document the behavior of the GHSA filtering function.

This commit is contained in:
Federico Builes
2022-10-11 15:09:58 +02:00
parent f632f5f79d
commit 1d9bfbbddf
2 changed files with 8 additions and 3 deletions
+6 -1
View File
@@ -51,7 +51,12 @@ export function filterChangesByScopes(
return filteredChanges
}
export function filterOutAllowedAdvisories(
/**
* @param ghsas - list of GHSA IDs to allow
* @param changes - list of changes to filter
* @returns a list of changes with the allowed GHSAs removed
*/
export function removeAllowedAdvisories(
ghsas: string[] | undefined,
changes: Changes
): Changes {