@vercel/functions 3.7.7 → 3.8.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/functions
 
+## 3.8.0
+
+### Minor Changes
+
+- 8fb6c4f: Adds getDeadline
+
 ## 3.7.7
 
 ### Patch Changes

package/deadline.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Returns the shared invocation deadline for the
+ * current function invocation, as a Date object.
+ */
+export declare function getDeadline(): Date | undefined;

package/deadline.js

@@ -0,0 +1,39 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var deadline_exports = {};
+__export(deadline_exports, {
+  getDeadline: () => getDeadline
+});
+module.exports = __toCommonJS(deadline_exports);
+var import_get_context = require("./get-context");
+function getDeadline() {
+  const deadline = (0, import_get_context.getContext)().deadline;
+  if (deadline === void 0) {
+    return void 0;
+  }
+  const date = new Date(deadline);
+  if (isNaN(date.getTime())) {
+    return void 0;
+  }
+  return date;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDeadline
+});

package/docs/index/README.md

@@ -33,6 +33,7 @@
 - [experimental_upgradeWebSocket](functions/experimental_upgradeWebSocket.md)
 - [geolocation](functions/geolocation.md)
 - [getCache](functions/getCache.md)
+- [getDeadline](functions/getDeadline.md)
 - [getEnv](functions/getEnv.md)
 - [invalidateBySrcImage](functions/invalidateBySrcImage.md)
 - [invalidateByTag](functions/invalidateByTag.md)

package/docs/index/functions/getDeadline.md

@@ -0,0 +1,16 @@
+[**@vercel/functions**](../../README.md)
+
+***
+
+# Function: getDeadline()
+
+> **getDeadline**(): [`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) \| `undefined`
+
+Defined in: [packages/functions/src/deadline.ts:7](https://github.com/vercel/vercel/blob/main/packages/functions/src/deadline.ts#L7)
+
+Returns the shared invocation deadline for the
+current function invocation, as a Date object.
+
+## Returns
+
+[`Date`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date) \| `undefined`

package/get-context.d.ts

@@ -5,6 +5,7 @@ import { PurgeApi } from './purge/types';
 import { AddCacheTagApi } from './addcachetag/types';
 type Context = {
     waitUntil?: (promise: Promise<unknown>) => void;
+    deadline?: string;
     cache?: RuntimeCache;
     purge?: PurgeApi;
     addCacheTag?: AddCacheTagApi;

package/index.d.ts

@@ -1,6 +1,7 @@
 export type { Request, Geo } from './headers';
 export { geolocation, ipAddress } from './headers';
 export { getEnv } from './get-env';
+export { getDeadline } from './deadline';
 export { waitUntil } from './wait-until';
 export { rewrite, next } from './middleware';
 export { getCache } from './cache';

package/index.js

@@ -26,6 +26,7 @@ __export(src_exports, {
   experimental_upgradeWebSocket: () => import_websocket.experimental_upgradeWebSocket,
   geolocation: () => import_headers.geolocation,
   getCache: () => import_cache.getCache,
+  getDeadline: () => import_deadline.getDeadline,
   getEnv: () => import_get_env.getEnv,
   invalidateBySrcImage: () => import_purge.invalidateBySrcImage,
   invalidateByTag: () => import_purge.invalidateByTag,
@@ -37,6 +38,7 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 var import_headers = require("./headers");
 var import_get_env = require("./get-env");
+var import_deadline = require("./deadline");
 var import_wait_until = require("./wait-until");
 var import_middleware = require("./middleware");
 var import_cache = require("./cache");
@@ -54,6 +56,7 @@ var import_websocket = require("./websocket");
   experimental_upgradeWebSocket,
   geolocation,
   getCache,
+  getDeadline,
   getEnv,
   invalidateBySrcImage,
   invalidateByTag,

package/package.json

@@ -30,7 +30,7 @@
       "require": "./middleware.js"
     }
   },
-  "version": "3.7.7",
+  "version": "3.8.0",
   "repository": {
     "directory": "packages/functions",
     "type": "git",