Add comment documenting HttpClient#headers type. (#1325)

stripe · Jan 10, 2022 · 44d65a1 · 44d65a1
1 parent a916752
commit 44d65a1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/types/net/net.d.ts b/types/net/net.d.ts
@@ -19,6 +19,11 @@ declare module 'stripe' {
  port: string | number,
  path: string,
  method: 'GET' | 'POST' | 'PUT' | 'DELETE',
+ // object is used here as this is implementation-specific. This is
+ // generally {[key: string]: string}, but various underlying clients
+ // support other types as well. As examples:
+ // - Node supports {[key: string]: string | number | string[]}.
+ // - Fetch supports a Headers object.
  headers: object,
  requestData: string | null,
  protocol: Stripe.HttpProtocol,