webiny-api-scheduler-catalog

Catalogs Webiny scheduler abstractions for scheduling, executing, and canceling scheduled actions.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-scheduler-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-scheduler-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/scheduler
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-scheduler-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with the Webiny API scheduler package need to know which use cases, services, and types exist and where to import them from, without manually searching the codebase.

Core Features & Use Cases

  • Abstraction Catalog: Lists 15 scheduler abstractions including ScheduleActionUseCase, CancelScheduledActionUseCase, ExecuteScheduledActionUseCase, and SchedulerService with exact import paths.
  • Source References: Points to the source file in @webiny/api-scheduler for each abstraction so you can read exact interfaces and types.
  • Use Case: When implementing content publishing workflows, look up ScheduleActionUseCase and the SCHEDULED_ACTION_PUBLISH constant to schedule an entry for future publication.

Quick Start

Ask the AI to schedule a publish action for a CMS entry using the Webiny scheduler abstractions listed in this catalog.

Frequently Asked Questions about webiny-api-scheduler-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I schedule an action in Webiny?

Use ScheduleActionUseCase from the webiny/api/scheduler import path to schedule an action for future execution. Read the source at @webiny/api-scheduler/features/ScheduleAction/index.ts for the exact interface and types.

How do I cancel a scheduled action in Webiny?

Use CancelScheduledActionUseCase, imported from webiny/api/scheduler, to cancel a previously scheduled action. Its implementation is defined in @webiny/api-scheduler/features/CancelScheduledAction/index.ts.

What scheduled action types does Webiny support?

The scheduler defines SCHEDULED_ACTION_PUBLISH and SCHEDULED_ACTION_UNPUBLISH constants in @webiny/api-scheduler/constants.ts. The ScheduledActionType type describes the action type structure.

Can I execute a scheduled action immediately in Webiny?

Yes, ExecuteScheduledActionUseCase runs a scheduled action immediately instead of waiting for its scheduled time. Import it from webiny/api/scheduler and check the source for required parameters.

How do I handle namespace-specific scheduled actions in Webiny?

Use NamespaceHandler from webiny/api/scheduler to implement namespace-specific scheduled action logic. Pair it with ScheduledActionHandler to handle the actual execution of a scheduled action.