Skip to content

Commit

Permalink
chore(docs): Update @ngrx/entity documentation examples and usage (#369)
Browse files Browse the repository at this point in the history
Closes #367
  • Loading branch information
brandonroberts authored and MikeRyanDev committed Sep 11, 2017
1 parent 47f4ca8 commit 669b2f4
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 40 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
[ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting -->
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request
</code></pre>

## What is the current behavior?
Expand Down
6 changes: 3 additions & 3 deletions docs/entity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Entity State adapter for managing record collections.

@ngrx/entity provides an API to manipulate and query entity collections.

- Reduces boilerplate for managing common datasets
- Provides performant operations for managing entity collections
- Extensible type-safe adapters for selecting entity information
- Reduces boilerplate for creating reducers that manage a collection of models.
- Provides performant CRUD operations for managing entity collections.
- Extensible type-safe adapters for selecting entity information.

### Installation
Install @ngrx/entity from npm:
Expand Down
55 changes: 19 additions & 36 deletions docs/entity/adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ returned adapter provides many [methods](#adapter-methods) for performing operat
against the collection type. The method takes an object for configuration with 2 properties.

- `selectId`: A `method` for selecting the primary id for the collection
- `sort`: A [sort function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) for sorting the collection. Set to `false` to leave collection unsorted.
- `sort`: A compare function used to [sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) the collection. The comparer function is only needed if the collection needs to be sorted before being displayed. Set to `false` to use leave the collection unsorted, which is more performant during CRUD operations.

Usage:

Expand Down Expand Up @@ -84,8 +84,8 @@ state if no changes were made.
* `addOne`: Add one entity to the collection
* `addMany`: Add multiple entities to the collection
* `addAll`: Replace current collection with provided collection
* `removeOne`: Remove one entity to the collection
* `removeMany`: Remove multiple entities to the collection
* `removeOne`: Remove one entity from the collection
* `removeMany`: Remove multiple entities from the collection
* `removeAll`: Clear entity collection
* `updateOne`: Update one entity in the collection
* `updateMany`: Update multiple entities in the collection
Expand Down Expand Up @@ -176,16 +176,17 @@ export type All =

`user.reducer.ts`
```ts
import * as user from './user.actions';
import { EntityState, EntityAdapter, createEntityAdapter } from '@ngrx/entity';
import { User } from './user.model';
import * as UserActions from './user.actions';

export interface State extends EntityState<User> {
// additional entities state properties
selectedUserId: number | null;
}

export const adapter: EntityAdapter<User> = createEntityAdapter<User>({
selectId: (user: User) => user.id,
sort: true,
selectId: (user: User) => user.id
});

export const initialState: State = adapter.getInitialState({
Expand All @@ -198,46 +199,28 @@ export function reducer(
action: UserActions.All
): State {
switch (action.type) {
case user.ADD_USER: {
return {
...state,
...adapter.addOne(action.payload.user, state),
};
case UserActions.ADD_USER: {
return adapter.addOne(action.payload.user, state);
}

case user.ADD_USERS: {
return {
...state,
...adapter.addMany(action.payload.users, state),
};
case UserActions.ADD_USERS: {
return adapter.addMany(action.payload.users, state);
}

case user.UPDATE_USER: {
return {
...state,
...adapter.updateOne(action.payload.user, state),
};
case UserActions.UPDATE_USER: {
return adapter.updateOne(action.payload.user, state);
}

case user.UPDATE_USERS: {
return {
...state,
...adapter.updateMany(action.payload.users, state),
};
case UserActions.UPDATE_USERS: {
return adapter.updateMany(action.payload.users, state);
}

case user.LOAD_USERS: {
return {
...state,
...adapter.addAll(action.payload.users, state),
};
case UserActions.LOAD_USERS: {
return adapter.addAll(action.payload.users, state);
}

case user.CLEAR_USERS: {
return {
...adapter.removeAll(state),
selectedUserId: null
};
case UserActions.CLEAR_USERS: {
return adapter.removeAll({ ...state, selectedUserId: null });
}

default: {
Expand Down

0 comments on commit 669b2f4

Please sign in to comment.