Parameter bag types with index signatures are too lax #413
Assignees
Labels
priority: low
This PR should be reviewed after all high and medium PRs.
status: in progress
This issue is being worked on.
type: chore
This PR contains changes that are not covered by other types (stylistic, dependency updates, etc).
Comments
parfeon
added
status: in progress
parfeon
added a commit
that referenced
this issue
Oct 30, 2024
Fix definition of type which represent message actions received from history and list of users which added action of specific type and value to the message. Closes #407 refactor(types): remove indexed signature for publish Remove redundant indexed signature from publish message parameters type definition. Closes #413 refactor(types): add serializable objects to `Payload` type Extend `Payload` type definition with objects which can be serialized by `JSON.stringify` using `toJSON()` methods. Closes #412 refactor(types): aggregate generated types definitions Aggregate multiple types definitions into single type definition type with proper type names and namespaces. Closes #405 #409 #410 refactor(types): add missing Subscribe Event Engine types Add Subscribe Event Engine and Event Listener types to the bundled types definition file. Closes #377
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In several places, inputs that would otherwise be strictly structured contain index signatures which allow the user to specify properties with any key. This prevents the typings from being able to catch misspellings and other mistakes. Specifically, in argument "bags".
For example,
PublishParameterscontains an index signature "for deprecated parameters", but this allows the following misspelling without any warning or error:Without the index signature, Typescript would flag
storeInHistorwith the error:Object literal may only specify known properties, but 'storeInHistor' does not exist in type 'PublishParameters'. Did you mean to write 'storeInHistory'?Rather than an index signature, deprecated params should be explicitly listed but marked as deprecated. Or, a dedicated subkey or alternate param should be provided for specifying arbitrary keys which are merged when sent to the API.
The text was updated successfully, but these errors were encountered: