Skip to content
This repository was archived by the owner on Jun 22, 2021. It is now read-only.

Commit 7ff6569

Browse files
authored
docs(readme): Improves docs.
1 parent 4024061 commit 7ff6569

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

readme.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,15 @@ const todosFacade = factory<TodoEntity>({
3131
constructFilter: (filter) => {
3232
return filter;
3333
},
34-
// Optional property.
34+
// Optional property. Defaults to 10.
3535
defaultPaginationLimit: 10,
3636
// Optional property to handle transactions. Defaults to "utils/handleTransaction".
3737
handleTransaction: async ({ req, res }, handler) => {
3838
// The transactionId allow items found in logs to be matched with responses to users.
3939
const transactionId = uuid();
4040
try {
41+
// This executes the Express request/response handler for a particular route.
42+
// Avoid changing behaviour here for certain routes, create a Github issue and we can discuss your use case.
4143
await handler({ transactionId });
4244
} catch (err) {
4345
// The default handleTransaction uses "utils/handleError" here.

0 commit comments

Comments
 (0)