webiny-api-tasks-catalog

Catalogs Webiny TaskDefinition and TaskService abstractions for background task implementation.

8.0k|673|Updated Jan 9, 2018

Search Tags:#api #typeScript #webiny #Serverless #Background Tasks #taskdefinition #taskservice

One-click install

npx skills add https://github.com/webiny/webiny-js --skill webiny-api-tasks-catalog

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: webiny-api-tasks-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/tasks
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-tasks-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with the Webiny framework need to locate the correct abstractions and import paths for defining and triggering long-running background tasks without digging through the monorepo source code.

Core Features & Use Cases

Abstraction Catalog: Lists the TaskDefinition and TaskService abstractions with exact import paths and source file locations.
Implementation Guidance: Points to related pattern skills (use-case and event-handler patterns) for correct usage.
Use Case: When building a Webiny API feature that requires a long-running background job, look up TaskDefinition to define the task lifecycle hooks and TaskService to trigger and manage its execution.

Quick Start

Ask the assistant to show the Webiny abstraction for defining and triggering a long-running background task in the api/tasks module.

Frequently Asked Questions about webiny-api-tasks-catalog

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

FAQPage Schema

How do I define a background task in Webiny?▼

Use the TaskDefinition abstraction imported from webiny/api/tasks to define a long-running background task with lifecycle hooks. The source is located at @webiny/api-core/features/task/TaskDefinition/index.ts.

How do I trigger a long-running task in Webiny API?▼

Use the TaskService abstraction from webiny/api/tasks to trigger and manage long-running background tasks. Its source is at @webiny/api-core/features/task/TaskService/index.ts.

What abstractions are available in the Webiny api/tasks module?▼

The api/tasks module exposes two abstractions: TaskDefinition for defining tasks with lifecycle hooks, and TaskService for triggering and managing task execution.

Where can I find implementation patterns for Webiny tasks?▼

Refer to the webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns. Always read the referenced source files to get exact interfaces and types before importing.