add comment and link to PR explaining why the refence type is there

decentralized-identity · May 2, 2024 · facd2f7 · facd2f7
1 parent 6005992
commit facd2f7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/api/src/protocol.ts b/packages/api/src/protocol.ts
@@ -1,3 +1,7 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/TBD54566975/web5-js/pull/507
+ */
 /// <reference types="@tbd54566975/dwn-sdk-js" />
 
 import type { DwnMessage, DwnResponseStatus, Web5Agent } from '@web5/agent';

diff --git a/packages/api/src/record.ts b/packages/api/src/record.ts
@@ -1,3 +1,7 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/TBD54566975/web5-js/pull/507
+ */
 /// <reference types="@tbd54566975/dwn-sdk-js" />
 
 import type { Readable } from '@web5/common';