gchumillas / schema-fixer Goto Github PK

Context:

The parse function is returning the errors as any[] type:

// src/index.d.ts
export function parse<T extends Schema>(value: any, schema: T): [Value<T>, errors: any[]]

which provides little information about the errors structure.

Possible Fix:

Update src/index.d.ts and replace any[] with something more descriptive. For example:

// src/index.d.ts
export type Errors = string | { path: string; errors: Errors }[]
// ...
export function parse<T extends Schema>(value: any, schema: T): [Value<T>, errors: Errors]

Was playing with the library and got a bit stuck at what to do w/ Date objects.

I tried casting as "string" but it didn't like that, and there wasn't a pipe for "object". I was able to pipe to "number" which seems to call .getTime(), I think.

Not sure if a built-in pipe for Date objects would be generally useful. If it receives a Number value, it could do new Date(value), if it receives a Date value, pass it through as-is, if it receives a String value maybe it does some Date.parse() or something. Possibly defaults to the current date if no date provided.

The required attribute is confusing. For example:

// always outputs { data: '' }, no matter if required is false or true
console.log({ data: sf.fix(undefined, sf.string()) })
console.log({ data: sf.fix(undefined, sf.string({ required: false })) })
console.log({ data: sf.fix(undefined, sf.string({ required: true })) })

// outputs { data: undefined }
console.log({ data: sf.fix(undefined, sf.string({ required: false, default: undefined })) })

Should we remove it? After all, the purpose of this library is "fixing" data rather than "evaluating" data.