From d153f52bf9606f00430f1a0c16efa02a69a194d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Ole=C5=9B?= Date: Sat, 24 Jun 2017 23:52:21 +0200 Subject: [PATCH] Improve documentation a little bit --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d462ee7..877ddd1 100644 --- a/README.md +++ b/README.md @@ -68,14 +68,27 @@ const user = new User({ userName: 'piotr', permissions: Set([Permission.DEVELOPER]) }); + user.getUserName(); // > piotr -user.hasPermission(Permission.ADMIN); // false +user.isAdmin(); // false + -// we create adminUser based on user - immutable data +// create admin user based on user - immutable data const adminUser = user.addPermission(Permission.ADMIN); // make me an admin! + adminUser.getUserName(); // > piotr -adminUser.hasPermission(Permission.ADMIN); // > true -user.hasPermission(Permission.ADMIN); // false +adminUser.isAdmin(); // > true +user.isAdmin(); // > false + + +// create another user +const anotherUser = new User({ + userName: 'lukasz', + createdBy: adminUser +}); + +anotherUser.isAdmin(); // > false +anotherUser.isCreatedByAdmin(); // > true ``` Like you see, `User` class hides complexity of Immutable.js structures and contains business logic.