add note to jsdoc

MetaMask · Sep 17, 2024 · 396bc37 · 396bc37
1 parent bb80c95
commit 396bc37
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/snaps-utils/src/url.ts b/packages/snaps-utils/src/url.ts
@@ -13,6 +13,8 @@ export const SNAP_PATHS = ['/home'];
  * Parse a url string to an object containing the authority, path and Snap id (if snap authority).
  * This also validates the url before parsing it.
  *
+ * Note: The Snap id returned from this function should always be validated to be an installed snap.
+ *
  * @param str - The url string to validate and parse.
  * @returns A parsed url object.
  * @throws If the authority or path is invalid.