webiny-api-key-value-store-catalog

Catalogs Webiny key-value store 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-key-value-store-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-api-key-value-store-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/key-value-store
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-key-value-store-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers working with the Webiny framework need to quickly locate the correct key-value store abstraction and its exact import path without digging through the monorepo source code.

Core Features & Use Cases

  • Abstraction Catalog: Lists the GlobalKeyValueStore (non-tenant-scoped) and KeyValueStore (tenant-scoped) abstractions with their import statements.
  • Source References: Points directly to the source file in @webiny/api-core so you can read exact interfaces and types before implementing.
  • Use Case: When building a Webiny API feature that needs to persist simple state, look up whether you need tenant-scoped or global storage, copy the import, and read the linked source for the exact interface.

Quick Start

Ask which Webiny key-value store abstraction to use for tenant-scoped data and get the import path and source file location.

Frequently Asked Questions about webiny-api-key-value-store-catalog

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

FAQPage Schema
How do I use a key-value store in Webiny API?

Import KeyValueStore from webiny/api/key-value-store for tenant-scoped storage or GlobalKeyValueStore for global storage. Read the source at @webiny/api-core/features/keyValueStore/index.ts to get the exact interface and types before implementing.

What is the difference between KeyValueStore and GlobalKeyValueStore in Webiny?

KeyValueStore is tenant-scoped, meaning stored data is isolated per tenant in multi-tenant deployments. GlobalKeyValueStore is non-tenant-scoped and stores data shared across the entire installation.

Where is the Webiny key-value store source code located?

Both abstractions are defined in @webiny/api-core/features/keyValueStore/index.ts within the webiny-js monorepo. Reading this file gives you the exact interface and type definitions.

When should I use tenant-scoped vs global key-value storage in Webiny?

Use the tenant-scoped KeyValueStore when data must be isolated per tenant in multi-tenant setups. Use GlobalKeyValueStore for shared configuration or state that applies across all tenants in the deployment.