Skip to content

Commit

Permalink
docs(core): document FastIterableDiffer module
Browse files Browse the repository at this point in the history
  • Loading branch information
trotyl committed Apr 8, 2018
1 parent 5793b21 commit fd219a0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Angular extensions powered by community.
+ [Change Detection Scheduler][ChangeDetectionScheduler]
+ [IterableDiffers Extensibility][IterableDiffersExtensibility]
+ [KeyValueDiffers Extensibility][KeyValueDiffersExtensibility]
+ [`FastIterableDiffer`][FastIterableDiffer]
+ `@angular-contrib/common`
+ [`<ng-host>`][NgHost]
+ [`ngForIn`][NgForIn]
Expand Down Expand Up @@ -65,6 +66,7 @@ class AppComponent { }


[ChangeDetectionScheduler]: https://github.com/trotyl/angular-contrib/tree/master/packages/core/change-detection-scheduler
[FastIterableDiffer]: https://github.com/trotyl/angular-contrib/tree/master/packages/core/fast-iterable-differ
[IterableDiffersExtensibility]: https://github.com/trotyl/angular-contrib/tree/master/packages/core/iterable-differs
[KeyValueDiffersExtensibility]: https://github.com/trotyl/angular-contrib/tree/master/packages/core/key-value-differs
[NgForIn]: https://github.com/trotyl/angular-contrib/tree/master/packages/common/for-in
Expand Down
34 changes: 34 additions & 0 deletions packages/core/fast-iterable-differ/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# FastIterableDiffer

An optimized `IterableDiffer` inspired by [Inferno](https://github.com/infernojs/inferno).

## Type

**Provider**

## Provenance

+ https://github.com/angular/angular/issues/18178

## NgModule

`@angular-contrib/core#FastIterableDifferModule`

## Usage

```typescript
@NgModule({
imports: [ FastIterableDifferModule ],
})
class MyModule { }
```

## Note

+ Non-keyed by default, please provide `trackBy` when expecting keyed behavior;
+ Duplicate keys are not allowed;
+ The operations detected will be different, but the result is same;

## Requirements

+ Map;

0 comments on commit fd219a0

Please sign in to comment.