Explain type

pixiebrix · Jul 8, 2024 · b07043b · b07043b
1 parent 38e6c11
commit b07043b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/components/PackageIcon.tsx b/src/components/PackageIcon.tsx
@@ -124,6 +124,8 @@ type PackageIconProps<T extends Metadata | PackageInstance> = {
  * @see Metadata
  * @see PackageInstance
  */
+// As of 2.0.5, the Metadata and PackageInstance types are currently equivalent. But include both in the union to make
+// the type signature more explicit.
 const PackageIcon = <T extends Metadata | PackageInstance>({
   packageOrMetadata,
   size,