webiny-api-build-params-catalog

Catalogs Webiny API build-time configuration parameter abstractions with import paths and source references.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with the Webiny framework need to locate the correct abstraction for accessing build-time configuration parameters without searching the entire codebase, and this catalog provides the exact interfaces, import paths, and source file locations.

Core Features & Use Cases

  • Abstraction Lookup: Lists the BuildParam and BuildParams abstractions with their exact TypeScript import statements from webiny/api/build-params.
  • Source References: Points directly to @webiny/api-core/features/buildParams/index.ts so you can read the exact interface and types before implementing.
  • Use Case: When building a Webiny API extension that needs to read build-time configuration values, consult this catalog to find the BuildParams abstraction, then follow the linked use-case or event-handler pattern skills for implementation.

Quick Start

Ask the AI to show you how to access build-time configuration parameters in a Webiny API project using the BuildParams abstraction.

Frequently Asked Questions about webiny-api-build-params-catalog

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

FAQPage Schema
How do I access build-time configuration parameters in Webiny API code?

Import the BuildParams abstraction from webiny/api/build-params and use it to read build-time configuration values. Read the source at @webiny/api-core/features/buildParams/index.ts first to get the exact interface and types.

What is the difference between BuildParam and BuildParams in Webiny?

BuildParam represents a single build-time configuration parameter, while BuildParams provides access to the collection of build-time configuration parameters. Both are exported from webiny/api/build-params.

Where is the Webiny build params source code located?

The source is located at @webiny/api-core/features/buildParams/index.ts. You should read this file to get the exact interface definitions and types before using the abstractions in your code.

Can I use BuildParams with Webiny event handlers or use cases?

Yes, the catalog directs you to the webiny-use-case-pattern and webiny-event-handler-pattern skills for implementation patterns. These show how to integrate abstractions like BuildParams into standard Webiny API workflows.