mojotech / mojotech/json-type-validation
object decoder should have an option to throw error if extra properties are present
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 154
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
If an object is run through the decoder at runtime, there should be a way to configure the decoder to throw an error if the decoded object has extra properties not defined on the original decoder.
For example, given the following decoder:
interface MyType {
myProperty?: string;
}
const MyTypeDecoder: Decoder<MyType> = object({
myProperty: optional(string());
});
There should be an additional combinator to make the decoder throw an error given the following input:
const myTypeRuntimeValue: MyType = {
myProperty: "someValue",
myOtherProperty: "This one isn't defined on the interface"
};
// I want this to throw an error because myTypeRuntimeValue has
// an additional property not defined in the interface
const decoded = MyTypeDecoder.runWithException(myTypeRuntimeValue);
The combinator could be something like exact(value), e.g.
interface MyType {
myProperty?: string;
}
const MyTypeDecoder: Decoder<MyType> = exact(object({
myProperty: optional(string());
}));
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the object(), Decoder, optional(), string(), and runWithException entry points, then review existing decoder tests. Define how the proposed exact() combinator should treat undeclared properties and errors. Done means extra properties reliably cause decoding failure while declared and optional properties continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100