mikaelvesavuori / mikrovalid Goto Github PK

In README at line 102 the example says:

{
  "properties": {
    "username": {
      "type": "string"
    }
  },
  "required": ["name"]
}

Where the required property name does not exist in the properties declaration, or the valid input in the following paragraph.

Would a PR with a suggestion on stricter types for the schema input be of interest?

In MikroValid.ts, the example has the required properties on the same level as the actual properties.

In the tests and in the README, those properties are on the same level as the properties property.

The way they are placed in the code description is similar to how they are placed in the rest of the hierarchy, like

work: {
  office: 'string', // <- referenced by required on the same level
  currency: 'string',
  salary: 'number',
  required: ['office'] // <- here
},
// ---------- Tests and README
{
  properties: {
    thing: {},  // <- referenced by required on one level up
  },
  required: ['thing'] // <- only on this level for things inside properties?
}

If this is an inconsistency, and it would be addressed, it is also valid for additionalProperties . (Not explicitly written in the code description though).

Also in the code description:

work: {
  office: 'string', // <- These should be `{ type: 'string' }` ?
  currency: 'string',
  salary: 'number',
  required: ['office']
},