resend 6.31.0 → 6.32.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "resend",
-  "version": "6.31.0",
+  "version": "6.32.0",
   "description": "Node.js library for the Resend API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/readme.md

@@ -134,6 +134,47 @@ console.log(`Email ${data.id} with a React template has been sent`);
 >});
 >```
 
+## Request options
+
+Every method takes request options as its last argument. Use `signal` to cancel a request or set a timeout, and `headers` to add request headers:
+
+```ts
+const controller = new AbortController();
+await resend.emails.send({ ... }, { signal: controller.signal });
+
+// With a timeout (Node.js 18+) and a custom header
+await resend.emails.list(
+  { limit: 50 },
+  { signal: AbortSignal.timeout(5000), headers: { 'X-Trace-Id': traceId } },
+);
+```
+
+An aborted request returns a network-failure error with a `null` status code. To tell a cancel apart from a real failure, check the status code and `signal.aborted`, and do not match on the error message:
+
+```ts
+const signal = AbortSignal.timeout(5000);
+const { error } = await resend.emails.list({}, { signal });
+
+if (error?.statusCode === null && signal.aborted) {
+  // The request was cancelled or timed out.
+}
+```
+
+When a method has an optional argument before the request options, pass `undefined` in its place:
+
+```ts
+await resend.broadcasts.send(broadcastId, undefined, { signal });
+```
+
+A chained `publish()` sends a separate request, so it takes its own options:
+
+```ts
+await resend.templates
+  .create({ name: 'welcome', html: '<p>Hi</p>' }, { signal })
+  .publish({ signal });
+```
+
 ## License
 
 MIT License
+