@axonlabs/core
    Preparing search index...

    Interface AxonPlugin

    interface AxonPlugin {
        mode: PluginMode;
        name: string;
        version: string;
        init(core: AxonCore): Promise<void>;
        [methodName: string]: any;
    }

    Indexable

    • [methodName: string]: any

      Rest of plugin methods.

    Index

    Properties

    Methods

    Properties

    This field submit your plugin environment mode to use.

    • production
    • development
    • both
    name: string

    This field submit your plugin name for AxonCore.

    version: string

    This field submit your plugin version for AxonCore.

    NOTE: It's better to use semantic versioning and also without 'v' or 'V' keyword.

    Methods

    • This is the start point of your plugin, Initialize method.

      Parameters

      • core: AxonCore

        An instance of AxonCore that used in project and ready to use.

      Returns Promise<void>