arkenv 0.7.1 → 0.7.2

package/README.md

@@ -14,6 +14,10 @@
 </p>
 <h3 align="center">Proud member of the <a href="https://arktype.io/docs/ecosystem#arkenv">ArkType ecosystem</a></h3>
 
+<p align="center">
+  <img alt="ArkEnv Demo" src="https://arkenv.js.org/assets/demo.gif" />
+</p>
+
 <br/>
 <br/>
 <br/>
@@ -23,12 +27,13 @@
 <br/>
 <br/>
 
-## Introduction
+## Introduction 
 
+> [!TIP]
+> 📖 **Reading this on GitHub?** Check out [this page in our docs](https://arkenv.js.org/docs) to hover over code blocks and get type hints!
 
 ArkEnv is an environment variable parser powered by [ArkType](https://arktype.io/), TypeScript's 1:1 validator. ArkEnv lets you use familiar TypeScript-like syntax to create a ready to use, typesafe environment variable object:
 
-
 ```ts twoslash
 import arkenv from 'arkenv';
 
@@ -38,12 +43,10 @@ const env = arkenv({
   NODE_ENV: "'development' | 'production' | 'test'",
 });
 
-
-// Automatically validate and parse process.env
-// TypeScript knows the ✨exact✨ types!
-console.log(env.HOST);     // (property) HOST: string
-console.log(env.PORT);     // (property) PORT: number
-console.log(env.NODE_ENV); // (property) NODE_ENV: "development" | "production" | "test"
+// Hover to see ✨exact✨ types
+const host = env.HOST;
+const port = env.PORT;
+const nodeEnv = env.NODE_ENV;
 ```
 
 With ArkEnv, your environment variables are **guaranteed to match your schema**. If any variable is incorrect or missing, the app won't start and a clear error will be thrown:
@@ -61,7 +64,9 @@ ArkEnvError: Errors found while validating environment variables
 - Tiny: <1kB gzipped
 - Build-time and runtime validation
 - Single import, zero config for most projects
+- Validated, defaultable, typesafe environment variables
 - Powered by ArkType, TypeScript's 1:1 validator
+- Optimized from editor to runtime
 
 ## Installation
 
@@ -99,11 +104,8 @@ bun add arkenv arktype
 
 :rocket: **Let's get started!** Read the [2-minute setup guide](https://arkenv.js.org/docs/quickstart) or [start with an example](https://arkenv.js.org/docs/examples).
 
-
 > [!TIP]
-> Improve your DX with syntax highlighting in [VS Code & Cursor](/docs/integrations/vscode) or [JetBrains IDEs](/docs/integrations/jetbrains).
-> 
-> ![ArkType syntax highlighting in VS Code](https://raw.githubusercontent.com/yamcodes/arkenv/main/assets/dx.png)
+> Improve your DX with *syntax highlighting* in [VS Code & Cursor](https://arkenv.js.org/docs/integrations/vscode) or [JetBrains IDEs](https://arkenv.js.org/docs/integrations/jetbrains).
 
 ## Requirements
 

package/dist/index.d.cts

@@ -81,6 +81,10 @@ declare const $: arktype.Scope<{
 
 type RuntimeEnvironment = Record<string, string | undefined>;
 type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
+/**
+ * TODO: If possible, find a better type than "const T extends Record<string, unknown>",
+ * and be as close as possible to the type accepted by ArkType's `type`.
+ */
 /**
  * Create an environment variables object from a schema and an environment
  * @param def - The environment variable schema
@@ -88,7 +92,7 @@ type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
  * @returns The validated environment variable schema
  * @throws An {@link ArkEnvError | error} if the environment variables are invalid.
  */
-declare function createEnv<const T extends Record<string, string | undefined>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
+declare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
 
 declare const type: arktype_internal_type_ts.TypeParser<{
     string: arktype.Submodule<{

package/dist/index.d.ts

@@ -81,6 +81,10 @@ declare const $: arktype.Scope<{
 
 type RuntimeEnvironment = Record<string, string | undefined>;
 type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
+/**
+ * TODO: If possible, find a better type than "const T extends Record<string, unknown>",
+ * and be as close as possible to the type accepted by ArkType's `type`.
+ */
 /**
  * Create an environment variables object from a schema and an environment
  * @param def - The environment variable schema
@@ -88,7 +92,7 @@ type EnvSchema<def> = type$1.validate<def, (typeof $)["t"]>;
  * @returns The validated environment variable schema
  * @throws An {@link ArkEnvError | error} if the environment variables are invalid.
  */
-declare function createEnv<const T extends Record<string, string | undefined>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
+declare function createEnv<const T extends Record<string, unknown>>(def: EnvSchema<T>, env?: RuntimeEnvironment): distill.Out<type$1.infer<T, (typeof $)["t"]>>;
 
 declare const type: arktype_internal_type_ts.TypeParser<{
     string: arktype.Submodule<{

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "arkenv",
   "type": "module",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,9 +32,9 @@
   "author": "Yam Borodetsky <yam@yam.codes>",
   "devDependencies": {
     "@ark/schema": "^0.49.0",
-    "@types/node": "24.3.1",
+    "@types/node": "24.6.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "arktype": "^2.1.22"