@andrewcaires/api 5.3.4 → 5.3.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.
Files changed (5) hide show
  1. package/README.md +22 -18
  2. package/dist/index.cjs.js +2 -2
  3. package/dist/index.d.ts +180 -63
  4. package/dist/index.esm.js +2 -2
  5. package/package.json +7 -7
package/README.md CHANGED
@@ -18,24 +18,28 @@ The module is now available on npm! `npm i @andrewcaires/api`
18
18
 
19
19
  NODE_ENV=development
20
20
 
21
- API_DB_TYPE=mariadb
22
- API_DB_DATABASE=database
23
- API_DB_HOST=localhost
24
- API_DB_USERNAME=root
25
- API_DB_PASSWORD=root
26
- API_DB_LOG=false
27
- API_DB_PORT=3306
28
-
29
- API_HTTP_PORT=3000
30
- API_HTTP_PUBLIC=/public
31
- API_HTTP_CROSS=true
32
-
33
- // API_HTTP_CRT=./ssl/http.crt
34
- // API_HTTP_KEY=./ssl/http.key
35
-
36
- // API_TOKEN_CRT=./ssl/token.crt
37
- // API_TOKEN_KEY=./ssl/token.key
38
- API_TOKEN_LIFETIME=1d
21
+ DATABASE_URI=mariadb://root:root@localhost:3306/database
22
+ DATABASE_LOG=false
23
+
24
+ HTTP_PORT=3000
25
+ HTTP_PATH=/api
26
+ HTTP_PUBLIC=/public
27
+ HTTP_CROSS=true
28
+
29
+ // HTTP_TLS_CRT=./ssl/http.crt
30
+ // HTTP_TLS_KEY=./ssl/http.key
31
+
32
+ TOKEN_SECRET=change-me-to-a-long-random-secret
33
+ TOKEN_TTL=1d
34
+ TOKEN_TTL_RENEW=1d
35
+ TOKEN_COOKIE=authorization
36
+ TOKEN_COOKIE_SET=true
37
+ TOKEN_HEADER=authorization
38
+ TOKEN_TYPE=bearer
39
+
40
+ KEY_HEADER=x-api-key
41
+ KEY_PREFIX=api
42
+ KEY_PEPPER=change-me-to-a-long-random-pepper
39
43
 
40
44
  API_WEBSOCKET_START=false
41
45
  ```