iso-conf

iso-conf

Simple config handling for your app or module with Standard Schema validation and extended JSON serialization

Features

• Fully typed via Standard Schema — works with Zod, Valibot, ArkType, and more
• Extended JSON types (URL, Map, Set, bigint, RegExp, Uint8Array)
• Atomic writes to disk
• Dot-notation access for nested properties
• Change hooks (onDidChange, onDidAnyChange)
• Defaults from schema

Install

pnpm install iso-conf

Usage

import { z } from 'zod/v4'
import { Conf } from 'iso-conf'

const schema = z.object({
  foo: z.number().min(1).max(100).default(50),
  bar: z.url().optional(),
})

const config = new Conf({ projectName: 'my-app', schema })

config.set('foo', 42)
console.log(config.get('foo'))
//=> 42

Any Standard Schema compliant library can be used for the schema option. Zod is shown above as an example only.

Defaults and required fields

Missing top-level keys are filled from the defaults option and then from schema defaults, on every read and write. defaults is required when the schema has required fields without a schema default, since a fresh config would otherwise fail validation.

const schema = z.object({
  token: z.string(),
  retries: z.number().default(3),
})

const config = new Conf({ projectName: 'my-app', schema, defaults: { token: '' } })

config.reset('token') // => ''
config.clear() // => { token: '', retries: 3 }

The schema output is what gets written to disk and validated again on the next read, so it must also be valid schema input. Transforms that change a value's type (e.g. z.string().transform((s) => s.length)) are rejected on write.

Docs

Check https://hugomrdias.github.io/iso-repo/modules/iso_conf.html

License

MIT Hugo Dias