@bintvn/lite-env 1.0.1 → 1.0.2
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 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# lite-env
|
|
1
|
+
# @bintvn/lite-env
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@bintvn/lite-env` is a small TypeScript-first environment loader for Node.js. It reads `.env` and `.env.{NODE_ENV}`, merges them, parses values into runtime types, and returns a type-safe object inferred from your schema.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
npm install lite-env
|
|
16
|
+
npm install @bintvn/lite-env
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Quick Start
|
|
@@ -22,7 +22,7 @@ Create your env files:
|
|
|
22
22
|
|
|
23
23
|
```env
|
|
24
24
|
# .env
|
|
25
|
-
APP_NAME
|
|
25
|
+
APP_NAME=@bintvn/lite-env
|
|
26
26
|
PORT=3000
|
|
27
27
|
DEBUG=false
|
|
28
28
|
```
|
|
@@ -36,7 +36,7 @@ TAGS=api,dev,local
|
|
|
36
36
|
Use `loadEnv` in your app:
|
|
37
37
|
|
|
38
38
|
```ts
|
|
39
|
-
import { loadEnv } from 'lite-env'
|
|
39
|
+
import { loadEnv } from '@bintvn/lite-env'
|
|
40
40
|
|
|
41
41
|
const env = loadEnv({
|
|
42
42
|
APP_NAME: 'string',
|
|
@@ -113,7 +113,7 @@ const env = loadEnv({
|
|
|
113
113
|
|
|
114
114
|
## Supported Types
|
|
115
115
|
|
|
116
|
-
|
|
116
|
+
`@bintvn/lite-env` currently supports the following schema kinds:
|
|
117
117
|
|
|
118
118
|
| Schema value | Result type | Notes |
|
|
119
119
|
| --- | --- | --- |
|
|
@@ -127,7 +127,7 @@ const env = loadEnv({
|
|
|
127
127
|
|
|
128
128
|
## Type Inference
|
|
129
129
|
|
|
130
|
-
The main goal of
|
|
130
|
+
The main goal of `@bintvn/lite-env` is type-safe inference from the input schema.
|
|
131
131
|
|
|
132
132
|
```ts
|
|
133
133
|
const env = loadEnv({
|