@momsfriendlydevco/cowboy 1.1.0 → 1.1.1

package/README.md

@@ -63,6 +63,21 @@ export default cowboy()
 		req => widgetStore.delete(req.params.id)
 	)
 };
+
+
+Cron schedule handling
+----------------------
+Cron scheduling is a little basic at the moment but likely to improve in the future.
+To set up a Cron handler simply install it by calling `.schedule(callback)`:
+
+```javascript
+import cowboy from '@momsfriendlydevco/cowboy';
+
+export default cowboy()
+	.schedule(async (event, env, ctx) => {
+		// Handle cron code here
+	})
+```
 ```
 
 Debugging
@@ -141,6 +156,11 @@ Cowboy.proxy(path, request, env)
 Forward from one route to another as if the second route was called first.
 
 
+Cowboy.schedule(callback)
+-------------------------
+Install a scheduled Cron handler function.
+
+
 CowboyRequest
 -------------
 ```javascript

package/lib/cowboy.js

@@ -166,6 +166,20 @@ export class Cowboy {
 	}
 
 
+	/**
+	* Set up Cloudflare response to "scheduled" call
+	* This is really just a map to the last handler we installed to .schedule(cb) - for now
+	*
+	* @param {CloudflareEvent} event The Cloudflare event context passed
+	* @param {Object} env Environment variables
+	* @param {CloudflareContext} ctx The Cloudflare context to respond to
+	*/
+	scheduled(event, env, ctx) {
+		if (!this.schedule.handler) throw new Error('Attemped to access Cowboy.scheduled without first calling .schedule() to set something up!');
+		return this.schedule.handler.call(this, event, env, ctx);
+	}
+
+
 	/**
 	* Call a router function as if it were invoked directly
 	* This function exists as an easier way to remap body contents without
@@ -255,6 +269,19 @@ export class Cowboy {
 	options(path, ...middleware) { return this.route('OPTIONS', path, ...middleware) }
 
 
+	/**
+	* Handle cron job scheduling
+	*
+	* @param {Function} cb The callback to install for all scheduled events. Called as `(event:CloudflareEvent, env:Object, ctx:CloudflareContext)`
+	* @returns {Cowboy} This chainable Cowboy router instance
+	*/
+	schedule(handler) {
+		console.info('Installed schedule event handler. Access via http://localhost:8787/__scheduled');
+		this.schedule.handler = handler;
+		return this;
+	}
+
+
 	/**
 	* Generial Init() sequence
 	* This will be run automatically on setup or the first fetch()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@momsfriendlydevco/cowboy",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Wrapper around Cloudflare Wrangler to provide a more Express-like experience",
   "scripts": {
     "lint": "eslint ."