guido-extension-role-biz

Provide a biz property to the roles substate.

Usage

First import the relevant properties than use it.

Import

The code can be used as an ES Module

import { manifest } from '@guido.software/guido-extension-role-biz'

or as IIFE:

<script src="./js/vendor/guido-extension-role-biz.min.js"></script>
<script>window.biz = window.software.guido.extensions.role.biz</script>

API

The Guido.Software pieces expose the following object and functions. As extension it is responsible for updating the state on well-defined events.

Manifest

The manifest is describing the extension. At some point it will likely be turned into a JSON file.

• name: The display name for this extension.
• version: The semantic version of this extension.
• description: A single line summarising the purpose of this extension.
• dependentOn: Only allow this extension to load if the conditions are met.
• peerDependentOn: Utilise these if they are present but don't fail if they are absent.
• provides: Expose conditions to be met by other extensions.

Components

This extension does not register any components.

Event Listeners

This extension updates the state on loading of itself.

Reducers

If the event above is met, an action will be dispatched that is triggering the reducer here. See Redux for details on the terms.

Installation

With npm:

npm install @guido.software/guido-extension-role-biz

With yarn

yarn add @guido.software/guido-extension-role-biz

Issues

The code is mirrored on Codeberg in case you want to report errors. I don't accept registrations on my Forgejo instance.

LICENSE

AGPL version 3 or newer. See LICENSE