fix(storage-plugin): expose storage plugin internals privately through subpackage #2052
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
…h subpackage This commit exposes some of the storage plugin internals through a subpackage, following a similar approach to how router plugin internals are exposed. These internals are necessary to expose if someone wishes to extend the storage engine's behavior. For example, to check for the default state key `@@STATE` or to use helper functions like extracting string keys.
arturovt
requested review from
markwhitfeld,
kuncevic,
Carniatto,
poloagustin,
joaqcid and
splincode
as code owners
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 8435b01. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch ✅ Successfully ran 3 targetsSent with 💌 from NxCloud. |
BundleMon (Integration Projects)Unchanged files (1)
Total files change -7B -0.01% Final result: ✅ View report in BundleMon website ➡️ |
markwhitfeld
requested changes
Sep 15, 2023
| @@ -23,9 +23,9 @@ export type StorageKey = string | StateClass | StateToken<any> | KeyWithExplicit | |||
|
|
|||
| /** This symbol is used to store the metadata on state classes. */ | |||
| const META_OPTIONS_KEY = 'NGXS_OPTIONS_META'; | |||
| export function exctractStringKey(storageKey: StorageKey): string { | |||
| export function ɵexctractStringKey(storageKey: StorageKey): string { | |||
There was a problem hiding this comment.
Let's fix the spelling of this API before we expose it.
Suggested change
| export function ɵexctractStringKey(storageKey: StorageKey): string { | |
| export function ɵextractStringKey(storageKey: StorageKey): string { |
|
Code Climate has analyzed commit 8435b01 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 95.9% (0.5% change). View more on Code Climate. |
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.
This commit exposes some of the storage plugin internals through a subpackage, following a similar approach to how router plugin internals are exposed. These internals are necessary to expose if someone wishes to extend the storage engine's behavior. For example, to check for the default state key
@@STATEor to use helper functions like extracting string keys.