@convex-dev/crons 0.1.3 → 0.1.5

package/README.md

@@ -2,8 +2,6 @@
 
 [![npm version](https://badge.fury.io/js/@convex-dev%2Fcrons.svg)](https://badge.fury.io/js/@convex-dev%2Fcrons)
 
-**Note: Convex Components are currently in beta.**
-
 <!-- START: Include on https://convex.dev/components -->
 
 This Convex component provides functionality for registering and managing cron
@@ -11,6 +9,24 @@ jobs at runtime. Convex comes with built-in support for cron jobs but they must
 be statically defined at deployment time. This library allows for dynamic
 registration of cron jobs at runtime.
 
+```ts
+// Register a cron to run once per day.
+const daily = await crons.register(
+  ctx,
+  { kind: "cron", cronspec: "0 0 * * *" },
+  internal.example.logStuff,
+  { message: "daily cron" }
+);
+
+// Register a cron to run every hour.
+const hourly = await crons.register(
+  ctx,
+  { kind: "interval", ms: 3600000 },
+  internal.example.logStuff,
+  { message: "hourly cron" }
+);
+```
+
 It supports intervals in milliseconds as well as cron schedules with the same
 format as the unix `cron` command:
 

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/esm/package.json

@@ -1,3 +1,3 @@
 {
-  "type": "commonjs"
+  "type": "module"
 }

package/package.json

@@ -7,7 +7,7 @@
     "email": "support@convex.dev",
     "url": "https://github.com/get-convex/crons/issues"
   },
-  "version": "0.1.3",
+  "version": "0.1.5",
   "license": "Apache-2.0",
   "keywords": [
     "convex",
@@ -20,7 +20,7 @@
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs",
     "build:esm": "tsc --project ./esm.json && echo '{\\n  \"type\": \"module\"\\n}' > dist/esm/package.json",
-    "build:cjs": "tsc --project ./commonjs.json && echo '{\\n  \"type\": \"commonjs\"\\n}' > dist/esm/package.json",
+    "build:cjs": "tsc --project ./commonjs.json && echo '{\\n  \"type\": \"commonjs\"\\n}' > dist/commonjs/package.json",
     "typecheck": "tsc --noEmit",
     "prepare": "npm run build"
   },