@leancodepl/config 9.6.5 → 9.6.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @leancodepl/config - Utility for creating configuration getters that access Vite-injected values in development and environment variables in production.
|
|
2
2
|
|
|
3
|
-
Provides a function to create getters for accessing configuration values prefixed with '
|
|
3
|
+
Provides a function to create getters for accessing configuration values prefixed with 'VITE\_' from `import.meta.env`
|
|
4
|
+
during development. In production, it retrieves values directly from environment variables, with support for tools like
|
|
5
|
+
nginx-base from "leancodepl/tools" for parsing.
|
|
4
6
|
|
|
5
7
|
## Installation
|
|
6
8
|
|
|
@@ -18,9 +20,11 @@ yarn add @leancodepl/config
|
|
|
18
20
|
|
|
19
21
|
### `mkGetInjectedConfig()`
|
|
20
22
|
|
|
21
|
-
Creates a getter function for accessing Vite-injected configuration values from environment variables on development, on
|
|
23
|
+
Creates a getter function for accessing Vite-injected configuration values from environment variables on development, on
|
|
24
|
+
production it will return the value from the environment variables. You can check "@leancodepl/tools" repository for
|
|
25
|
+
more information. There's nginx-base defined which parses it out.
|
|
22
26
|
|
|
23
|
-
The keys are automatically prefixed with '
|
|
27
|
+
The keys are automatically prefixed with 'VITE\_' when accessing import.meta.env.
|
|
24
28
|
|
|
25
29
|
**Returns:** An object containing the `getInjectedConfig` method.
|
|
26
30
|
|