Skip to content

Rename slice to name and tweaks some examples #220

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 16, 2019
Merged

Rename slice to name and tweaks some examples #220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/usage/usage-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,7 @@ Here's how that posts example would look with `createSlice:

```js
const postsSlice = createSlice({
name: 'posts',
initialState: [],
reducers: {
createPost(state, action) {},
Expand All @@ -454,6 +455,7 @@ const postsSlice = createSlice({
console.log(postsSlice)
/*
{
name: 'posts',
actions : {
createPost,
updatePost,
Expand All @@ -471,11 +473,9 @@ console.log(createPost({ id: 123, title: 'Hello World' }))

`createSlice` looked at all of the functions that were defined in the `reducers` field, and for every "case reducer" function provided, generates an action creator that uses the name of the reducer as the action type itself. So, the `createPost` reducer became an action type of `"createPost"`, and the `createPost()` action creator will return an action with that type.

You can also optionally define a `slice` parameter with a string that will be used as the prefix of the action types:

```js
const postsSlice = createSlice({
slice: 'posts',
name: 'posts',
initialState: [],
reducers: {
createPost(state, action) {},
Expand All @@ -496,7 +496,7 @@ Most of the time, you'll want to define a slice, and export its action creators

```js
const postsSlice = createSlice({
slice: 'posts',
name: 'posts',
initialState: [],
reducers: {
createPost(state, action) {},
Expand Down