-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3dd4050
commit d2e328f
Showing
1 changed file
with
48 additions
and
0 deletions.
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 |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
'xstate': minor | ||
--- | ||
|
||
An opt-in `createModel()` helper has been introduced to make it easier to work with typed `context` and events. | ||
|
||
- `createModel(initialContext)` creates a `model` object | ||
- `model.initialContext` returns the `initialContext` | ||
- `model.assign(assigner, event?)` creates an `assign` action that is properly scoped to the `event` in TypeScript | ||
|
||
See https://github.com/davidkpiano/xstate/pull/1439 for more details. | ||
|
||
```js | ||
import { createMachine } from 'xstate'; | ||
import { createModel } from 'xstate/lib/model'; // opt-in, not part of main build | ||
|
||
interface UserContext { | ||
name: string; | ||
age: number; | ||
} | ||
|
||
type UserEvents = | ||
| { type: 'updateName'; value: string } | ||
| { type: 'updateAge'; value: number } | ||
|
||
const userModel = createModel<UserContext, UserEvents>({ | ||
name: 'David', | ||
age: 30 | ||
}); | ||
|
||
const assignName = userModel.assign({ | ||
name: (_, e) => e.value // correctly typed to `string` | ||
}, 'updateName'); // restrict to 'updateName' event | ||
|
||
const machine = createMachine<UserContext, UserEvents>({ | ||
context: userModel.context, | ||
initial: 'active', | ||
states: { | ||
active: { | ||
on: { | ||
updateName: { | ||
actions: assignName | ||
} | ||
} | ||
} | ||
} | ||
}); | ||
``` |