@netlify/functions - npm Package Compare versions

Comparing version 0.10.0 to 0.11.0-rc

dist/main.d.ts

 export { builder } from './lib/builder';
+export { schedule } from './lib/schedule';
 export * from './function';

dist/main.js

@@ -13,5 +13,7 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.builder = void 0;
+exports.schedule = exports.builder = void 0;
 var builder_1 = require("./lib/builder");
 Object.defineProperty(exports, "builder", { enumerable: true, get: function () { return builder_1.builder; } });
+var schedule_1 = require("./lib/schedule");
+Object.defineProperty(exports, "schedule", { enumerable: true, get: function () { return schedule_1.schedule; } });
 __exportStar(require("./function"), exports);

package.json

@@ -5,3 +5,3 @@ {
   "types": "./dist/main.d.ts",
-  "version": "0.10.0",
+  "version": "0.11.0-rc",
   "description": "JavaScript utilities for Netlify Functions",
@@ -62,3 +62,3 @@ "files": [
     "@commitlint/config-conventional": "^13.0.0",
-    "@netlify/eslint-config-node": "^3.3.8",
+    "@netlify/eslint-config-node": "^3.3.10",
     "ava": "^2.4.0",
@@ -65,0 +65,0 @@ "husky": "^4.3.8",

README.md

@@ -52,2 +52,26 @@ # ![functions](functions.png)
 
+### Scheduled Functions (currently in beta)
+
+To use Scheduled Functions, wrap your function handler with the `schedule` function.
+
+- With JavaScript:
+
+  ```js
+  const { schedule } = require('@netlify/functions')
+
+  exports.handler = schedule('5 4 * * *', async () => {
+    console.log("It's 04:05 AM!")
+  })
+  ```
+
+- With TypeScript:
+
+  ```ts
+  import { schedule } from '@netlify/functions'
+
+  export const handler = schedule("5 4 * * *", async () => {
+    console.log("It's 04:05 AM!")
+  })
+  ```
+
 ### TypeScript typings
@@ -54,0 +78,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

28265

increased by6.92%

Number of package files

25

increased by8.7%

Lines of code

498

increased by9.45%

Number of lines in readme file

105

increased by29.63%

No dependency changes