Feat(base config builder): allow async overrides #2177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 7f86a26 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
odinr
changed the title
odinr
force-pushed
the
feat/base-config-builder/allow-async-overrides
branch
2 times, most recently
from
3feb2d6
to
17d3a59
Compare
Allow `_createConfig` method in `BaseConfigBuilder` to return `ObservableInput<TConfig>` instead of `Observable<TConfig>`. This enables more flexibility in how the config is created, as the method can return a Promise or other observable-like type.
…lbacks - Add `_get` method to retrieve the configuration callback for a given target path - Add `_has` method to check if a target path exists in the configuration callbacks
- Improve documentation and examples for BaseConfigBuilder - Update type annotations and JSDoc comments for better type safety and clarity
- Add `@sealed` decorator to public methods in `BaseConfigBuilder` - Change access modifiers of some methods to `@protected`
odinr
force-pushed
the
feat/base-config-builder/allow-async-overrides
branch
from
17d3a59
to
7f86a26
Compare
Coverage Report
File Coverage
|
||||||||||||||||||||||||||||||||||||||
AndrejNikolicEq
approved these changes
May 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
This PR introduces changes to the
BaseConfigBuilderclass in the@equinor/fusion-frameworkpackage. The current behavior of theBaseConfigBuilderclass is that it provides a way to build and configure modules by defining configuration callbacks for different parts of the module's configuration. However, the implementation has some limitations and lacks proper documentation.The new behavior introduced by this PR is an improved and more flexible implementation of the
BaseConfigBuilderclass. It includes better handling of nested configurations, improved type safety, and more comprehensive documentation. Additionally, it introduces new helper methods for working with configuration callbacks and adds examples to illustrate the usage of the class.This PR does not introduce any breaking changes, as it maintains backward compatibility with the existing API.
Changes
BaseConfigBuilderclass, including a detailed example of how to use it._getand_hasto retrieve and check for the existence of configuration callbacks._createConfigto useswitchMapinstead ofmergeMapfor better handling of asynchronous operations._buildConfigmethod to use more descriptive comments and better variable naming._processConfigmethod to illustrate how it can be used for post-processing and validating the configuration.Benefits
BaseConfigBuilderclass.Check off the following: