@arkenv/core 1.0.0-alpha.5 → 1.0.0-alpha.7

package/dist/index.d.mts

@@ -6102,15 +6102,12 @@ type SafeArkEnvResult<T> = {
  * @returns An array of extracted key names
  */
 declare function getSchemaKeys(schema: any): string[]; //#endregion
-//#region src/utils/errors.d.ts
+//#region src/schema-capture.d.ts
 /**
- * Map a Standard Schema validation issue to a normalized EnvIssueCode.
+ * Start recording `arkenv()` schema arguments instead of validating the environment.
  *
- * @param engineCode The raw issue code from the Standard Schema engine
- * @param message The error message associated with the issue
- * @param receivedVal The raw value received by the validator
- * @returns The normalized EnvIssueCode classification
- * @internal
+ * CLI-supporting API: tools such as the ArkEnv CLI use this to inspect a user's
+ * schema module without requiring `process.env` to be populated.
  */
 //#endregion
 //#region ../internal/scope/dist/index.d.ts
@@ -6457,7 +6454,7 @@ type ArkenvOutput<T extends SchemaShape, D> = distill.Out<type$1.infer<T, $$1>>
  *
  * @param def The schema definition
  * @param config The evaluation configuration
- * @returns The parsed environment variables, or a SafeArkEnvResult if `{ safe: true }` is configured
+ * @returns The parsed environment variables, a SafeArkEnvResult if `{ safe: true }` is configured, or a value-less stub when schema capture is active
  * @throws An {@link ArkEnvError | error} if the environment variables are invalid and `safe` is not enabled
  */
 declare function arkenv<const T extends SchemaShape>(def: EnvSchema<T>, config?: ArkEnvConfig & {