@kwiz/common 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/package.json +1 -1
- package/readme.md +14 -10
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,13 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
# KWIZ Common Repo
|
|
2
|
+
|
|
3
|
+
A collection of common helpers and utilities used across KWIZ projects
|
|
4
|
+
|
|
5
|
+
To get started, configure our modules to your project by calling config:
|
|
2
6
|
|
|
3
|
-
1. import it using a sync task, under sub folder /sync_modules
|
|
4
|
-
2. ignore it in your git-ignore
|
|
5
|
-
3. might need to add this in your tsconfig include for types.d.ts files to work
|
|
6
7
|
```
|
|
7
|
-
"
|
|
8
|
+
import { config } from "@kwiz/common";
|
|
9
|
+
export const { logger: GetLogger } = config({
|
|
10
|
+
BuildNumber: BuildNumber,
|
|
11
|
+
//send true to have verbose logs and turn on debug mode
|
|
12
|
+
IsLocalDev: IsLocalDev,
|
|
13
|
+
ReleaseStatus: ReleaseStatus,
|
|
14
|
+
//prefix logger with your project name
|
|
15
|
+
ProjectName: "[cms]"
|
|
16
|
+
});
|
|
8
17
|
```
|
|
9
|
-
4. the parent folder must export in the _dependencies file:
|
|
10
|
-
1. IsLocalDev bool
|
|
11
|
-
1. BuildNumber string
|
|
12
|
-
1. ReleaseStatus string (fast ring, production, local dev etc)
|
|
13
|
-
|