Skip to content

docs(validator): say why fillDefaults drops the boolean arm #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
David Chicaiza (david0723) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(validator): say why fillDefaults drops the boolean arm #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,12 @@ export type FormanValidationOptions = {
* `appliedDefaults`. Values the caller provided are never overwritten, except `''`, which
* counts as an omission and fills — so under `'always'` a deliberately cleared optional
* field comes back with its default. An explicit `null` is a provided value: it never fills
* and still fails as mandatory. Inactive branches are never filled. */
* and still fails as mandatory. Inactive branches are never filled.
*
* BlueprintValidator's option also accepts `boolean`; that arm is deliberately not carried
* over. `useDefaults: true` is a legacy alias for `'always'` rather than a third behaviour,
* and the platform's own public validation parameter already exposes just the two named
* modes, so there is nothing behind the boolean for a new library to inherit. */
fillDefaults?: 'requiredOnly' | 'always';
/** Maps domain names used in nested.domain to actual domain keys passed to validateFormanWithDomains */
domainAliases?: Record<string, string>;
Expand Down