@memberjunction/global
v2.13.4
Published
MemberJunction: Global Object - Needed for ALL other MJ components
Downloads
2,908
Keywords
Readme
# @memberjunction/global
The `@memberjunction/global` library is designed to coordinate events and components across MemberJunction. This library exports a `MJGlobal` class along with a `RegisterClass` function decorator to manage class registration with the global class factory. It also exports some core elements from the `./ClassFactory` and `./interface` modules for ease of use.
## Installation
```bash
npm install @memberjunction/global
Usage
Below are some usage examples based on the provided code:
Importing the Library
import * as MJ from '@memberjunction/global';
Using the MJGlobal Class
// Getting the singleton instance of MJGlobal
const globalInstance = MJ.MJGlobal.Instance;
// Registering a component
globalInstance.RegisterComponent(yourComponent);
// Raising an event
globalInstance.RaiseEvent(yourEvent);
// Listening for events
const listener = globalInstance.GetEventListener();
Using the RegisterClass Decorator
@MJ.RegisterClass(yourBaseClass)
class YourClass {
// ...
}
Contributing
Feel free to open issues or pull requests if you have suggestions or fixes.
License
Specify the license for your project.
Support
For support, please contact [email protected] or open an issue on the project repository.
This README file provides a brief overview of the library, installation instructions, usage examples, and other common sections like contributing, license, and support information. You may want to further customize this file to better fit the `@memberjunction/global` library and its community, especially the support and license sections.