Skip to content

Commit cd1e00e

Browse files
committed
docs(README): added explanation about promise logs
1 parent e321256 commit cd1e00e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,19 @@ Logger.warn('Warning message example.');
2828
// => ⚠️ Warning message example
2929
Logger.info('Information message example.');
3030
// => ℹ️ Informational message example
31+
32+
// PROMISE STATUSES LOGS
33+
Logger.pending('Promise message example.', { hello: true });
34+
// => ℹ️ Promise message example | pending {"hello":true}
35+
36+
Logger.fulfilled('Promise message example.', { hello: true });
37+
// => ✅ Promise message example | fulfilled {"hello":true}
38+
39+
Logger.rejected('Promise message example.', { hello: true });
40+
// => 🚫 Promise message example | rejected {"hello":true}
41+
42+
Logger.settled('Promise message example.', { hello: true });
43+
// => ✅ Promise message example | settled {"hello":true}
3144
```
3245

3346
### With require
@@ -43,8 +56,23 @@ Logger.warn('Warning message example.');
4356
// => ⚠️ Warning message example
4457
Logger.info('Information message example.');
4558
// => ℹ️ Informational message example
59+
60+
// PROMISE STATUSES LOGS
61+
Logger.pending('Promise message example.', { hello: true });
62+
// => ℹ️ Promise message example | pending {"hello":true}
63+
64+
Logger.fulfilled('Promise message example.', { hello: true });
65+
// => ✅ Promise message example | fulfilled {"hello":true}
66+
67+
Logger.rejected('Promise message example.', { hello: true });
68+
// => 🚫 Promise message example | rejected {"hello":true}
69+
70+
Logger.settled('Promise message example.', { hello: true });
71+
// => ✅ Promise message example | settled {"hello":true}
4672
```
4773

74+
_Note: All promises convert objects to strings_
75+
4876
### Change Emojis
4977

5078
Is it possible to change emojis for each message? **Yes**! Check it out:

0 commit comments

Comments
 (0)