Skip to content

Commit 60387bf

Browse files
committed
docs: add helpers to readme
1 parent 8aaeca0 commit 60387bf

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

readme.md

+31
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,37 @@ exports `storageSettings` which can be used to configure the storage methods.
4848

4949
`ChromeStore` - This holds the data in chrome.store.local for use with Google Chrome extensions.
5050

51+
### Token Helpers
52+
53+
Linking in with the activeStorage, a number of token helpers are available.
54+
55+
`setActiveStorage` - set the active storage manager
56+
57+
`getActiveStorage` - get the current active storage manager
58+
59+
#### Helpers
60+
61+
`getClaim` - Get a single claim from the Access Token
62+
63+
`getClaims` - Get all claims from the Access Token
64+
65+
`getCurrentOrganization` - get the current authenticated organisation
66+
67+
`getDecodedToken` - get the decoded id or access token
68+
69+
`getFlag` - get a single feature flag
70+
71+
`getPermission` - get a single permission value
72+
73+
`getPermissions` - get all user permissions
74+
75+
`getRoles` - get all the users roles
76+
77+
`getUserOrganizations` - get all the organizations the user has access to
78+
79+
`getUserProfile` - get the profile of the user from the ID token
80+
81+
5182
## Kinde documentation
5283

5384
[Kinde Documentation](https://kinde.com/docs/) - Explore the Kinde docs

0 commit comments

Comments
 (0)