superstruct icon indicating copy to clipboard operation
superstruct copied to clipboard

Defaulted is not coerced through validate

Open BuyMyBeard opened this issue 1 year ago • 2 comments

Take the following code snippet:

const [err, data] = validate({str: 'str'}, object({str: string(), def: defaulted(string(), '')}));
console.log(err);
console.log(data);

The previous code will have this error message in the err object: StructError: At path: def -- Expected a string, but received: undefined.

Now take this code snippet instead:

create({str: 'str'}, object({str: string(), def: defaulted(string(), '')}));

This code works perfectly.

According to the tsdoc included with validate Validate a value against a struct, returning an error if invalid, or the value (with potential coercion) if valid., the value should still be coerced by defaulted, just like create.

BuyMyBeard avatar Dec 19 '24 21:12 BuyMyBeard

Found out there is an optional parameter for coerce on validate. I will leave this open, since I think the doc comment on validate is misleading. It should be more clear that it only coerces if the coerce parameter is set to true.

BuyMyBeard avatar Dec 19 '24 22:12 BuyMyBeard