composable-controller: Replace use of any with proper types (non-test files only)
#3716
Assignees
Labels
Comments
19 tasks
3 tasks
MajorLift
added a commit
that referenced
this issue
Feb 21, 2024
…pe checks for inputs, remove `#controllers` field (#3904) ## Explanation There are several issues with the current ComposableController implementation that should be addressed before further updates are made to the controller (e.g. #3627). - Removes `#controllers` class field, which is not being updated by `#updateChildController` or anywhere else. - Removing this makes it clear that the list of child controllers to be composed is determined at class instantiation and cannot be altered later. - This behavior is consistent with `#updateChildController` being a private method. - Types BaseController, ComposableController state with `Record<string, Json>` - Opted to use `any` to disable BaseController state type constraint, as there is no straightforward way to type `BaseControllerV1` state to be compatible with `Json`. - Adds a `isBaseController` type guard, ~and removes the deprecated `subscribed` property from `BaseController`~. - Removes `ControllerList` type in anticipation of #3627. Internally, `ControllerInstance` will be used to type child controllers or unions and tuples thereof. - Adds and exports `ControllerInstance`, `BaseControllerV{1,2}Instance` types. - Populates state metadata object in constructor with child controllers. ## References - Blocks #3627 - Closes #3716 - Replaces some TODOs with comment explaining necessity of `any` usage. - Closes #3907 ## Changelog Recorded under "Unreleased" heading in CHANGELOG files. ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Look for the following string in non-test files to find these:
// TODO: Replace `any` with typeAt time of writing, there were 2 instances.
The text was updated successfully, but these errors were encountered: