zodified-config-esm 2.1.0 → 2.1.1

package/README.md

@@ -0,0 +1,56 @@
+# Zodified Config
+
+Typesafe config validated by Zod 🎉
+
+## Install
+
+You can install `zodified-config-esm` from NPM using your prefered package manage. 
+
+For npm you can install as follows:
+
+```
+npm i zodified-config-esm
+```
+
+## Usage
+
+To use zodified-config, please follow the 3 steps explained below:
+
+### 1. Defining your schema
+```ts
+// src/schema.ts
+import z from 'zod';
+
+export const configSchema = z.object({
+  value: z.string()
+});
+
+export type Config = z.infer<typeof configSchema>;
+```
+
+### 2. Validating your config
+
+```ts
+// src/index.ts
+import config from 'zodified-config-esm'
+import type { Config } from './schema'
+
+declare module 'zodified-config-esm' {
+  interface ValidatedConfig extends Config {}
+}
+
+try {
+  zodifiedConfig.validate(invalidSchema);
+} catch (error: unknown) {
+  // if you enter here, it means the config is invalid or something else went wrong
+  // check the error.message
+}
+```
+
+### 3. Accessing configuration values
+```ts
+// file other.ts
+import config from 'zodified-config-esm'
+
+config.get('value'); 
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zodified-config-esm",
   "type": "module",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "Typesafe config validated by Zod",
   "repository": {
     "type": "git",
@@ -13,6 +13,10 @@
     "node": ">=14"
   },
   "main": "./dist/index.js",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "files": [
     "dist"
   ],