refactor: mark .responseHeaders and .response as deprecated

anthropics · Jul 7, 2023 · 93a0445 · 93a0445
1 parent 2b4bce4
commit 93a0445
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/src/core.ts b/src/core.ts
@@ -572,6 +572,7 @@ export type FinalRequestOptions<Req extends {} = Record<string, unknown> | Reada
 };
 
 export type APIResponse<T> = T & {
+  /** @deprecated - we plan to add a different way to access raw response information shortly. */
   responseHeaders: Headers;
 };
 

diff --git a/src/streaming.ts b/src/streaming.ts
@@ -65,7 +65,9 @@ class SSEDecoder {
 }
 
 export class Stream<Item> implements AsyncIterable<Item>, APIResponse<Stream<Item>> {
+  /** @deprecated - please use the async iterator instead. We plan to add additional helper methods shortly. */
   response: Response;
+  /** @deprecated - we plan to add a different way to access raw response information shortly. */
   responseHeaders: Headers;
   controller: AbortController;
-Original file line number
+Diff line change
@@ Expand Up @@
     };
     export type APIResponse<T> = T & {
+      /** @deprecated - we plan to add a different way to access raw response information shortly. */
       responseHeaders: Headers;
     };
@@ Expand Down @@