From 8c4f5518cbba69f6ef4734d5112b043d7fedfc6a Mon Sep 17 00:00:00 2001 From: Patrizio Bekerle <patrizio@bekerle.com> Date: Thu, 4 Feb 2021 08:28:23 +0100 Subject: [PATCH] Document reserved attributes --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e1bb8586..84303a9b 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,12 @@ There is an automatic publishing process initiated for each package if code is p to the `master` branch, if the package isn't set to private in its `package.json` and the version number in its `package.json` is higher than the version number on npmjs.com. +## Reserved attributes + +| Attribute | Description | +| ----------------- | ------------------------------------------------------------------- | +| `subscribe` | Used in all components to subscribe to attributes set by a provider | +| `unsubscribe` | Reserved for future use | +| `auth` | Authentication information, set by the authentication component | +| `lang` | Currently selected language, set by the language selector | +| `entry-point-url` | Entry point url for all api requests | -- GitLab