Getting started

This tutorial gets a minimal ConfigBound setup running in a TypeScript app.

Install

npm install @config-bound/config-bound

Create a config

import {
  ConfigBound,
  configItem,
  configSection
} from "@config-bound/config-bound";
import { EnvVarBind } from "@config-bound/config-bound";
import { z } from "zod";

const config = await ConfigBound.createConfig(
  {
    port: configItem<number>({
      default: 3000,
      validator: z.number().int().min(1).max(65535)
    }),
    server: configSection({
      host: configItem<string>({
        default: "localhost",
        validator: z.hostname()
      })
    })
  },
  {
    binds: [new EnvVarBind()],
    validateOnInit: true
  }
);

const port = await config.get("app", "port");
const host = await config.get("server", "host");

What to read next

• Reference overview
• Bind API reference