@mrspartak/config
Typescript runtime configuration resolver
-
-
- ⚡️ Runtime validation (no more deployments with the wrong configuration) -
- 🧙♂️ TypeScript intelissense -
- 🍃 Light, zero external dependencies -
- 🤲 Merge configurations (defaults overwrite strategy) -
- 👓 Support for JSON file/url config, Object config, [soon] ENV -
- 🐻 Bring your validator library of choise. We support Zod, Valibot, Yup, Superstruct etc... -
- ✅ Well-tested and production ready. -
- [soon] Works as a run-time config provider on a front-end +
- ⚡️ Runtime Validation: Ensure your application never runs with the wrong configuration. +
- 🧙♂️ TypeScript IntelliSense: Leverage auto-completion and type-checking at development time. +
- 🍃 Zero Dependencies: Lightweight with no external dependencies +
- 🤲 Flexible Configuration Merging: Supports merging multiple configurations with a default overwrite strategy. +
- 👓 Versatile Configuration Sources: Load from JSON files, URLs, or direct objects. +
- 🐻 Extensible Validation Support: Compatible with Zod, Valibot, Yup, Superstruct, and more. +
- ✅ Production Ready: Thoroughly tested and stable for use.
- 📁 Support for .env files. +
- 🌐 Enhance front-end compatibility. +
- 📚 Expand documentation. +
- ⚙️ Integrate GitHub Actions for test coverage reporting. +
- Create a config resolver file -
- Import resolved configuration anywhere you need -
- $Validator extends Validator
- $Validator extends Validator
The validator type.
+
@mrspartak/config
Typescript runtime configuration resolver
@mrspartak/config is a robust TypeScript runtime configuration resolver designed to ensure that your application runs with the correct settings every time. It supports dynamic runtime validation, deep merging of configurations, and integrates seamlessly with your choice of data validation libraries.
+
-
+
Quickstart
# yarn
yarn add @mrspartak/config
# npm
npm i @mrspartak/config
# pnpm
pnpm add @mrspartak/config
# bun
bun add @mrspartak/config
+Roadmap
+
+Installation
# yarn
yarn add @mrspartak/config
# npm
npm i @mrspartak/config
# pnpm
pnpm add @mrspartak/config
# bun
bun add @mrspartak/config
-Usage
-
-import { fromJSONFile } from "@mrspartak/config";
import * as z from "zod"
const config = await fromJSONFile({
path: ["../config/default.json", "../config/runtime.json"],
schema: z.object({
db: z.object({
host: z.string(),
port: zv.number(),
username: z.string(),
password: z.string()
}),
app: z.object({
port: z.number().optional().default(3000)
})
}),
});
export default config
+Quick Start
Create a config resolver file
+// file: state/config.ts
import { fromJSONFile } from "@mrspartak/config";
import * as z from "zod"
const config = await fromJSONFile({
path: ["../config/default.json", "../config/runtime.json"],
schema: z.object({
db: z.object({
host: z.string(),
port: zv.number(),
username: z.string(),
password: z.string()
}),
app: z.object({
port: z.number().optional().default(3000)
})
}),
});
export default config
-
-
-import config from 'config.js'
import db from 'some-db-provider'
const dbClient = db(config.db) // config.db will have full intelisense
+Import resolved configuration anywhere you need
+// file: index.ts
// Import your resolved configuration
import config from './state/config.js';
// Use the configuration in your application
import db from 'some-db-provider';
const dbClient = db(config.db); // Enjoy IntelliSense here!
-
Type alias Validator
Type alias Validator
A base type representing any kind of validator, either distinguishing between input/output types or not.
+Type alias ValidatorCustomValidator<TI>
Represents a generic validator function that may return a promise or a direct value.
+Type Parameters
Type alias ValidatorMyZod<TI>
Represents a MyZod validator which contains a parse method for input data.
+Type Parameters
Type alias ValidatorSuperstruct<TI>
Represents a Superstruct validator which contains a create method to construct a typed object.
+Type Parameters
Type alias ValidatorValibot<TI, TPI>
Represents a Valibot validator with optional input and output types specification.
+Type Parameters
Type alias ValidatorWithInputOutput<TI, TPI>
Type Parameters
Type alias ValidatorWithInputOutput<TI, TPI>
A union type for validators that clearly separate input and output types.
+Type Parameters
Type alias ValidatorWithoutInput<TI>
Type Parameters
Type alias ValidatorWithoutInput<TI>
A union type for validators that do not distinguish between input and output types.
+Type Parameters
Type alias ValidatorYup<TI>
Represents a Yup validator which contains a synchronous validate method.
+Type Parameters
Type alias inferValidator<$Validator>
? {
in: $TIn;
out: $TOut;
}
: $Validator extends ValidatorWithoutInput<infer $InOut>
? {
in: $InOut;
out: $InOut;
}
: never
Type Parameters
Type alias inferValidator<$Validator>
? {
in: $TIn;
out: $TOut;
}
: $Validator extends ValidatorWithoutInput<infer $InOut>
? {
in: $InOut;
out: $InOut;
}
: never
Type utility to infer input and output types from a Validator type.
+Type Parameters
Returns
The inferred input and output types based on the validator specification.
+
Asynchronously reads and validates JSON data from one or more files against a provided schema.
+This function allows for the loading of configuration or data from JSON files specified by path or paths. +It handles reading multiple files in parallel, parses them as JSON, and then merges all objects into a single +object to be validated against a given schema. Exception handling is integrated to manage and report errors +effectively during file reading and parsing stages.
+Example
+