@clipboard-health/config 0.2.1 → 0.3.0
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 +1 -3
- package/package.json +1 -1
- package/src/lib/createConfig.d.ts +1 -3
- package/src/lib/createConfig.js +1 -3
- package/src/lib/createConfig.js.map +1 -1
package/README.md
CHANGED
|
@@ -58,9 +58,7 @@ dotenv.config();
|
|
|
58
58
|
* **IMPORTANT**: To avoid runtime errors:
|
|
59
59
|
* 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
|
|
60
60
|
* Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
|
|
61
|
-
* "false"`, use the
|
|
62
|
-
* {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
|
|
63
|
-
* `booleanString` schema} from `@clipboard-health/contract-core`.
|
|
61
|
+
* "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
|
|
64
62
|
* 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
|
|
65
63
|
* modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
|
|
66
64
|
* `Readonly<SchemaT>` because the former prevents clients from passing configuration values to
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clipboard-health/config",
|
|
3
3
|
"description": "Type-safe static configuration management: a pure function to resolve, validate against a Zod schema, and freeze configuration values.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.3.0",
|
|
5
5
|
"dependencies": {
|
|
6
6
|
"decamelize": "5.0.1",
|
|
7
7
|
"dotenv": "16.4.5",
|
|
@@ -23,9 +23,7 @@ import { type ConfigParams } from "./types";
|
|
|
23
23
|
* **IMPORTANT**: To avoid runtime errors:
|
|
24
24
|
* 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
|
|
25
25
|
* Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
|
|
26
|
-
* "false"`, use the
|
|
27
|
-
* {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
|
|
28
|
-
* `booleanString` schema} from `@clipboard-health/contract-core`.
|
|
26
|
+
* "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
|
|
29
27
|
* 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
|
|
30
28
|
* modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
|
|
31
29
|
* `Readonly<SchemaT>` because the former prevents clients from passing configuration values to
|
package/src/lib/createConfig.js
CHANGED
|
@@ -31,9 +31,7 @@ dotenv_1.default.config();
|
|
|
31
31
|
* **IMPORTANT**: To avoid runtime errors:
|
|
32
32
|
* 1. Environment variables are strings, so use `z.coerce` Zod types for those you plan to override.
|
|
33
33
|
* Note that `z.coerce.boolean()` coerces any truthy value to `true`. To restrict to `"true" |
|
|
34
|
-
* "false"`, use the
|
|
35
|
-
* {@link https://github.com/ClipboardHealth/core-utils/blob/main/packages/contract-core/src/lib/schemas/booleanString.ts
|
|
36
|
-
* `booleanString` schema} from `@clipboard-health/contract-core`.
|
|
34
|
+
* "false"`, use the `booleanString` schema from `@clipboard-health/contract-core`.
|
|
37
35
|
* 2. The resulting configuration is deeply frozen and will throw a runtime error if you attempt to
|
|
38
36
|
* modify it. The actual return type is `ReadonlyDeep<SchemaT>`, but the library returns a
|
|
39
37
|
* `Readonly<SchemaT>` because the former prevents clients from passing configuration values to
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createConfig.js","sourceRoot":"","sources":["../../../../../packages/config/src/lib/createConfig.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"createConfig.js","sourceRoot":"","sources":["../../../../../packages/config/src/lib/createConfig.ts"],"names":[],"mappings":";;AA6CA,oCAeC;;AA5DD,4DAA4B;AAC5B,+DAAoD;AAEpD,sDAAmD;AACnD,kDAA8C;AAG9C,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,SAAgB,YAAY,CAG1B,MAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC/C,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;IAEhC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAA,kBAAO,EAAC,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC7F,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAA,mCAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE;YAC3F,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAA,uBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}
|