Skip to content

Key Value Plugin

Плагин для управления данными в виде пар ключ-значение.

Установка

sh
npm install @runium/plugin-key-value
sh
yarn add @runium/plugin-key-value
sh
pnpm add @runium/plugin-key-value

Возможности

Плагин позволяет организовать работу с данными в виде пар ключ-значение.

Данный функционал полезен для централизованного хранения и переиспользования значений в разных проектах, например, для хранения конфигурационных данных или секретов.

Плагин шифрует данные перед их сохранением, что обеспечивает безопасность по сравнению с данными, хранящимися в открытом виде (например, пароли в переменных окружения).

WARNING

Несмотря на шифрование, использование плагина для хранения конфиденциальной информации, требующей высокого уровня защиты, не рекомендуется.

Команды

Плагин добавляет команды в группу runium kv.

  • runium kv set
  • runium kv get
  • runium kv remove
  • runium kv clear
  • runium kv list

TIP

Подробнее о командах, их аргументах и опциях см. в разделе Команды.

Макрос

Плагин добавляет макрос $kv для использования данных в конфигурации проекта.

TIP

Подробнее о макросах см. в разделе Макросы.

Пример

Записать значение в хранилище
sh
runium kv set some-key someValue
runium kv set some-other-key "Some long value"
Получить значение из хранилища
sh
runium kv get some-key
runium kv get some-other-key
Удалить значение из хранилища
sh
runium kv remove some-key
runium kv remove some-other-key
Очистить хранилище
sh
runium kv clear
Вывести список пар ключ-значение
sh
runium kv list
Использовать значение из хранилища в конфигурации проекта
json
{
  "value": "$kv(some-key)"
}