/dx-audit

Ship Sensible Defaults So the Common Case Is One Call

The most common usage should need the fewest arguments. If every caller passes the same boilerplate options, those defaults are wrong. Default to what 80% of users want and let the rest override. Keep the defaults observable (documented on the type, echoed in any structured output) and still require an explicit value for identity-bearing or destructive-scoping parameters, so nothing important is chosen silently.

Incorrect (forces boilerplate every call for the common case):

const client = new Client({
  retries: 3,
  timeout: 30_000,
  baseUrl: "https://api.example.com",
  format: "json",
}); // every user copies this same block

Correct (defaults cover the common case; override only the unusual):

const client = new Client(); // retries 3, 30s timeout, json by default
const slow = new Client({ timeout: 60_000 }); // override just what differs