TypeScript-Safe API Client

Типизированный REST-клиент для Payload с тем же синтаксисом запросов, что и у Local API

Сообщество 336 102/нед MIT v1.2.2

Установка

pnpm add @payload-enchants/sdk

Описание

TypeScript-Safe API Client — типизированный клиент для REST API сайта на Payload. Он использует ту же форму запросов, что и Local API, поэтому вызовы find, create, update и delete выглядят одинаково на сервере и во фронтенд-приложении. Документы возвращаются с типами, основанными на сгенерированных типах Payload вашего сайта, поэтому неверные имена полей выявляются на этапе компиляции.

Каждый запрос проходит через функцию fetch, которую можно заменить. В ней можно добавить API-ключ или заголовок сессии. Параметр выбора полей сужает возвращаемый тип до указанных полей. Обновление и удаление по ID включены как дополнительные операции.

О пакете

Имя пакета
@payload-enchants/sdk
Последняя версия
1.2.2
Размер
31 кБ
Лицензия
MIT
Загрузок в неделю
102
Последняя публикация
16 июл. 2024 г.

Ещё от r1tsuu

Профиль автора

Заполняет локализованный контент Payload в других локалях с помощью резолверов Google, OpenAI или копирования

Позволяет запросам API выбирать, какие поля возвращать, — по аналогии с выбором полей в GraphQL

Кэширует локальные чтения Payload для страниц и сбрасывает кэш при изменении контента

Позволяет каждой коллекции вычислять заголовок документа в админке с помощью пользовательской функции

Добавляет SEO-поля в выбранные коллекции Payload с заголовками и описаниями, которые можно генерировать через OpenAI

Показывает значение каждого локализованного поля во вкладках языков в административной панели

Типизированный клиент для REST API Payload с CRUD, авторизацией и загрузкой файлов

SDK для встроенного визуального редактирования на сайтах, работающих на Payload

Построитель запросов для Angular, который отправляет запросы к спискам в Payload и другие бэкенды через сигналы

Регистрирует пользовательские блоки с перетаскиванием для конструктора страниц Olgax

Позволяет компонентам Puck загружать отфильтрованные элементы коллекции Payload в виде готового к отображению свойства

Подписывающий клиент для API VAP и плагин Payload для входа и оформления заказа в витрине