-
Notifications
You must be signed in to change notification settings - Fork 70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Explain how .provide()
can not be called imperatively to override implementations
#142
Open
kevinmaes
wants to merge
5
commits into
main
Choose a base branch
from
kevin/explain-provide-in-more-detail
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d9b057c
Explain how `.provide()` can not be called imperatively to override i…
kevinmaes 2713e42
Wrap text in warning admonition
kevinmaes 2114c63
Add code example comment specifying not to do what is in the example
kevinmaes 7eb8ba5
Wrap the entire bad example in the warning admonition
kevinmaes 6049ad1
Emphasize the word "not"
kevinmaes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -110,7 +110,7 @@ const feedbackMachine = createMachine( | |
delays: { | ||
/* ... */ | ||
}, | ||
} | ||
}, | ||
); | ||
``` | ||
|
||
|
@@ -143,6 +143,31 @@ const feedbackActor = interpret(customFeedbackMachine).start(); | |
// logs 'Doing something custom!' | ||
``` | ||
|
||
:::warningxstate | ||
|
||
`machine.provide()` is not imperative but rather returns a new machine that includes the implementation overrides. | ||
|
||
Modifying the previous example, if we were to imperatively call `.provide()` on an existing machine, that would **not** change the machine’s behavior with our implementations. | ||
|
||
```ts | ||
// Do NOT do this! | ||
const feedbackMachine = createMachine({...}); | ||
|
||
feedbackMachine.provide({ | ||
actions: { | ||
doSomething: () => { | ||
console.log('Doing something custom!'); | ||
}, | ||
}, | ||
}); | ||
|
||
// This will NOT utilize the provided implementations. | ||
const feedbackActor = interpret(feedbackMachine).start(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be |
||
|
||
``` | ||
|
||
::: | ||
|
||
## Specifying types | ||
|
||
You can specify TypeScript types inside the machine config using the `.types` property: | ||
|
@@ -246,4 +271,4 @@ const machineWithImpls = machine.provide({ | |
/* ... */ | ||
}, | ||
}); | ||
``` | ||
``` |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Assign this to a new machine var and pass to
createActor(newMachine)