1.0.7 • Published 2 years ago

infra_config v1.0.7

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Библиотека для внтренних ресурсов. Она позволяет получать настройки конфигураций из сервиса конфигов.

Для работы библиотеки необходимо скачать в проект npm пакет env-cmd и изменить команду npm run build в package.json
    "build": "react-scripts build"  -->  "build": "env-cmd -f .env.development react-scripts build"
    указывать имя env файла не из примера, а исходя из своих наименований


Для инициализации проекта необходимо вызвать функцию initConfig - она принимает:
 - baseUrl - адрес без query параметра (type = 'string')
 - nameProject - имя проекта (type = 'string')
 - secretKey - секретный ключ, который был выдан при создании проекта в сервисе конфигов (type = 'string')


 initConfig следует вызвать где нибудь на самом верху проета, в компоненте, которая 100% будет отрендерена(ну или в месте получения конфига вызвать эту функцию)


 config - возвращает object с именем и значением конфигурации {name: 'nameConfig', value: 'valueConfig'}
 config принимает:
  - nameConfig - имя конфигурации, query параметр для baseUrl (type = 'string')
  - fn - принмает функцию обновления состояния (hook - React.useState)
  - nameEnv - запасной вариант если конфигурации в сервисе не окажется. с этим параметром функция вернет значение из локального .env файла (type = 'string')
    в React имена переменных окружения должны начинаться с REACT_APP
1.0.2

2 years ago

1.0.1

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.0

2 years ago