iii-browser-sdk 0.11.4-next.5 → 0.11.5-next.1

package/dist/index.d.cts

@@ -403,7 +403,7 @@ interface ISdk {
    * const trigger = iii.registerTrigger({
    *   type: 'cron',
    *   function_id: 'my-service::process-batch',
-   *   config: { schedule: '*\/5 * * * *' },
+   *   config: { expression: '0 *\/5 * * * * *' },
    * })
    *
    * // Later, remove the trigger
@@ -477,13 +477,13 @@ interface ISdk {
    *
    * @example
    * ```typescript
-   * type CronConfig = { schedule: string }
+   * type CronConfig = { expression: string }
    *
    * iii.registerTriggerType<CronConfig>(
    *   { id: 'cron', description: 'Fires on a cron schedule' },
    *   {
    *     async registerTrigger({ id, function_id, config }) {
-   *       startCronJob(id, config.schedule, () =>
+   *       startCronJob(id, config.expression, () =>
    *         iii.trigger({ function_id, payload: {} }),
    *       )
    *     },
@@ -586,7 +586,7 @@ type FunctionRef = {
  *
  * @example
  * ```typescript
- * type CronConfig = { schedule: string }
+ * type CronConfig = { expression: string }
  *
  * const cron = iii.registerTriggerType<CronConfig>(
  *   { id: 'cron', description: 'Fires on a cron schedule' },
@@ -594,13 +594,13 @@ type FunctionRef = {
  * )
  *
  * // Register a trigger -- type is inferred as CronConfig
- * cron.registerTrigger('my-fn', { schedule: '* * * * *' })
+ * cron.registerTrigger('my::fn', { expression: '0 *\/5 * * * * *' })
  *
  * // Register a function and bind a trigger in one call
  * cron.registerFunction(
- *   'my-fn',
+ *   'my::fn',
  *   async (data) => { return { ok: true } },
- *   { description: 'Cron-triggered function' },
+ *   { expression: '0 *\/5 * * * * *' },
  * )
  * ```
  */

package/dist/index.d.mts

@@ -403,7 +403,7 @@ interface ISdk {
    * const trigger = iii.registerTrigger({
    *   type: 'cron',
    *   function_id: 'my-service::process-batch',
-   *   config: { schedule: '*\/5 * * * *' },
+   *   config: { expression: '0 *\/5 * * * * *' },
    * })
    *
    * // Later, remove the trigger
@@ -477,13 +477,13 @@ interface ISdk {
    *
    * @example
    * ```typescript
-   * type CronConfig = { schedule: string }
+   * type CronConfig = { expression: string }
    *
    * iii.registerTriggerType<CronConfig>(
    *   { id: 'cron', description: 'Fires on a cron schedule' },
    *   {
    *     async registerTrigger({ id, function_id, config }) {
-   *       startCronJob(id, config.schedule, () =>
+   *       startCronJob(id, config.expression, () =>
    *         iii.trigger({ function_id, payload: {} }),
    *       )
    *     },
@@ -586,7 +586,7 @@ type FunctionRef = {
  *
  * @example
  * ```typescript
- * type CronConfig = { schedule: string }
+ * type CronConfig = { expression: string }
  *
  * const cron = iii.registerTriggerType<CronConfig>(
  *   { id: 'cron', description: 'Fires on a cron schedule' },
@@ -594,13 +594,13 @@ type FunctionRef = {
  * )
  *
  * // Register a trigger -- type is inferred as CronConfig
- * cron.registerTrigger('my-fn', { schedule: '* * * * *' })
+ * cron.registerTrigger('my::fn', { expression: '0 *\/5 * * * * *' })
  *
  * // Register a function and bind a trigger in one call
  * cron.registerFunction(
- *   'my-fn',
+ *   'my::fn',
  *   async (data) => { return { ok: true } },
- *   { description: 'Cron-triggered function' },
+ *   { expression: '0 *\/5 * * * * *' },
  * )
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iii-browser-sdk",
-  "version": "0.11.4-next.5",
+  "version": "0.11.5-next.1",
   "private": false,
   "publishConfig": {
     "access": "public"