Skills Development Webiny API Abstraction Catalog

Webiny API Abstraction Catalog

v20260424
webiny-api-catalog
This catalog details essential, foundational API abstractions for the Webiny framework. It provides standardized components for handling build parameters, managing domain events, utilizing key-value storage (tenant and global), structured logging, and robust result handling (Result type). Developers should use these abstractions to ensure their applications are modular, scalable, and architecturally sound.
Get Skill
350 downloads
Overview

api

How to Use

  1. Find the abstraction you need below
  2. You MUST 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: BuildParam Import: import { BuildParam } from "webiny/api" Source: @webiny/api-core/features/buildParams/index.ts Description: A single build-time configuration parameter.


Name: BuildParams Import: import { BuildParams } from "webiny/api" Source: @webiny/api-core/features/buildParams/index.ts Description: Access build-time configuration parameters.


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: DomainEvent Import: import { DomainEvent } from "webiny/api" Source: @webiny/api-core/features/eventPublisher/index.ts Description: Base class for all domain events.


Name: EventPublisher Import: import { EventPublisher } from "webiny/api" Source: @webiny/api-core/features/eventPublisher/index.ts Description: Publish domain events to registered handlers.


Name: GlobalKeyValueStore Import: import { GlobalKeyValueStore } from "webiny/api" Source: @webiny/api-core/features/keyValueStore/index.ts Description: Global (non-tenant-scoped) key-value store.


Name: KeyValueStore Import: import { KeyValueStore } from "webiny/api" Source: @webiny/api-core/features/keyValueStore/index.ts Description: Tenant-scoped key-value store.


Name: Logger Import: import { Logger } from "webiny/api" Source: @webiny/api-core/features/logger/index.ts Description: Structured logging with multiple log levels.


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.


Info
Category Development
Name webiny-api-catalog
Version v20260424
Size 17.55KB
Updated At 2026-04-28
Language