feat(functions): add scheduled functions templates (#4145)

* feat: add SF template for javascript & typescript

* Update src/functions-templates/javascript/scheduled-function/package.json

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* Update src/functions-templates/javascript/scheduled-function/{{name}}.js

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* Update src/functions-templates/typescript/scheduled-function/package.json

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* Update src/functions-templates/typescript/scheduled-function/{{name}}.ts

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>

* fix: applied suggested improvements

* fix: prefer inferred types over explicit ones

* chore: add helpful comments to SF-JS template

* chore: add helpful comments to SF-TS template

* chore: provide meaningful comments and examples

Co-authored-by: Eduardo Bouças <mail@eduardoboucas.com>
Co-authored-by: Erez Rokah <erezrokah@users.noreply.github.com>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: 4 people

src/functions-templates/javascript/scheduled-function/.netlify-function-template.js

@@ -0,0 +1,5 @@
+module.exports = {
+  name: 'scheduled-function',
+  priority: 1,
+  description: 'Basic implementation of a scheduled function in JavaScript.',
+}

src/functions-templates/javascript/scheduled-function/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "description": "netlify functions:create - scheduled function in JavaScript",
+  "main": "{{name}}.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "netlify",
+    "serverless",
+    "javascript",
+    "schedule"
+  ],
+  "author": "Netlify",
+  "license": "MIT",
+  "dependencies": {
+    "@netlify/functions": "^0.11.0"
+  }
+}

src/functions-templates/javascript/scheduled-function/{{name}}.js

@@ -0,0 +1,12 @@
+const { schedule } = require('@netlify/functions')
+
+// To learn about scheduled functions and supported cron extensions,
+// see: https://ntl.fyi/sched-func
+module.exports.handler = schedule('* * * * *', async (event) => {
+  const eventBody = JSON.parse(event.body)
+  console.log(`Next function run at ${eventBody.next_run}.`)
+
+  return {
+    statusCode: 200,
+  }
+})

src/functions-templates/typescript/scheduled-function/.netlify-function-template.js

@@ -0,0 +1,5 @@
+module.exports = {
+  name: 'scheduled-function',
+  priority: 1,
+  description: 'Basic implementation of a scheduled function in TypeScript.',
+}

src/functions-templates/typescript/scheduled-function/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "{{name}}",
+  "version": "1.0.0",
+  "description": "netlify functions:create - scheduled function in TypeScript",
+  "main": "{{name}}.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "netlify",
+    "serverless",
+    "typescript",
+    "schedule"
+  ],
+  "author": "Netlify",
+  "license": "MIT",
+  "dependencies": {
+    "@netlify/functions": "^0.11.0",
+    "@types/node": "^14.18.9",
+    "typescript": "^4.5.5"
+  }
+}

src/functions-templates/typescript/scheduled-function/{{name}}.ts

@@ -0,0 +1,12 @@
+import { schedule } from '@netlify/functions';
+
+// To learn about scheduled functions and supported cron extensions, 
+// see: https://ntl.fyi/sched-func
+export const handler = schedule("@hourly", (event) => {
+    const eventBody = JSON.parse(event.body);
+    console.log(`Next function run at ${eventBody.next_run}.`);
+
+    return {
+        statusCode: 200
+    };
+});