webiny-api-catalog

$npx mdskill add webiny/webiny-js/webiny-api-catalog

Define custom abstractions for webiny API features.

  • Creates reusable feature interfaces for building webiny applications.
  • Depends on the webiny/api module for core abstraction utilities.
  • Generates type-safe containers for handling success or failure states.
  • Provides functional programming patterns for error management.

SKILL.md

.github/skills/webiny-api-catalogView on GitHub ↗
---
name: webiny-api-catalog
context: webiny-api
description: >
  api — 4 abstractions.
---

# api

## How to Use

1. Find the abstraction you need below
2. Read the source file to get the exact interface and types
3. Import: `import { Name } from "<importPath>";`

## Abstractions

---

**Name:** `BaseError`
**Import:** `import { BaseError } from "webiny/api"`
**Source:** `@webiny/feature/api/index.ts`

---

**Name:** `createAbstraction`
**Import:** `import { createAbstraction } from "webiny/api"`
**Source:** `@webiny/feature/api/index.ts`

---

**Name:** `createFeature`
**Import:** `import { createFeature } from "webiny/api"`
**Source:** `@webiny/feature/api/index.ts`

---

**Name:** `Result`
**Import:** `import { Result } from "webiny/api"`
**Source:** `@webiny/feature/api/index.ts`
**Description:** A container type that represents either a successful result (`ok`) or a failure (`fail`).
Inspired by functional programming constructs like `Either` or `Result` in other languages.

---

More from webiny/webiny-js

SkillDescription
testerUse when running tests. Shows how to run tests for a single package, including OpenSearch (ddb-os) tests when applicable.
webiny-admin-aco-catalog>
webiny-admin-architect>
webiny-admin-build-params-catalog>
webiny-admin-catalog>
webiny-admin-cms-catalog>
webiny-admin-configs-catalog>
webiny-admin-env-config-catalog>
webiny-admin-form-catalog>
webiny-admin-graphql-client-catalog>