Skip to content

Commit 335477f

Browse files
committed
Added Features section to README.md
1 parent 105255c commit 335477f

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,23 @@ and Nicholas Schrock (@schrockn) from [Facebook](https://www.facebook.com/), the
3939

4040
## Features
4141

42-
- Yes, they will be listed here :)
42+
- Simple, intuitive API, using generics and fluent coding
43+
- Define batch load function with lambda expression
44+
- Schedule a load request in queue for batching
45+
- Add load requests from anywhere in code
46+
- Request returns [`Future<V>`](http://vertx.io/docs/apidocs/io/vertx/core/Future.html) of requested value
47+
- Can create multiple requests at once, returns [`CompositeFuture`](http://vertx.io/docs/apidocs/io/vertx/core/CompositeFuture.html)
48+
- Caches load requests, so data is only fetched once
49+
- Can clear individual cache keys, so data is fetched on next load request dispatch
50+
- Can prime the cache with key/values, to avoid data being fetched needlessly
51+
- Can configure cache key function with lambda expression to extract cache key from complex data loader key types
52+
- Dispatch load request queue when batch is prepared, returns `CompositeFuture`
53+
- Individual batch futures complete as batch is processed
54+
- `CompositeFuture`s results are ordered according to insertion order of load requests
55+
- Deals with partial errors when a batch future fails
56+
- Can disable batching and/or caching in configuration
57+
- Can supply your own [`CacheMap<K, V>`](https://github.com/engagingspaces/vertx-dataloader/blob/master/src/main/java/io/engagingspaces/vertx/dataloader/CacheMap.java) implementations
58+
- Has very high test coverage (see [Acknowledgements](#acknowlegdements))
4359

4460
## Differences to reference implementation
4561

0 commit comments

Comments
 (0)