Plugin: {
    methods: {
        close: {
            I: typeof Empty;
            O: typeof Empty;
            kind: Unary;
            name: "Close";
        };
        configure: {
            I: typeof PluginConfiguration;
            O: typeof Empty;
            kind: Unary;
            name: "Configure";
        };
        getInfo: {
            I: typeof Empty;
            O: typeof PluginInfo;
            kind: Unary;
            name: "GetInfo";
        };
    };
    typeName: "v1.Plugin";
} = ...

Plugin is the general service definition for a Webmesh plugin. It must be implemented by all plugins.

Type declaration

  • Readonly methods: {
        close: {
            I: typeof Empty;
            O: typeof Empty;
            kind: Unary;
            name: "Close";
        };
        configure: {
            I: typeof PluginConfiguration;
            O: typeof Empty;
            kind: Unary;
            name: "Configure";
        };
        getInfo: {
            I: typeof Empty;
            O: typeof PluginInfo;
            kind: Unary;
            name: "GetInfo";
        };
    }
    • Readonly close: {
          I: typeof Empty;
          O: typeof Empty;
          kind: Unary;
          name: "Close";
      }

      Close closes the plugin. It is called when the node is shutting down.

      Generated

      from rpc v1.Plugin.Close

      • Readonly I: typeof Empty
      • Readonly O: typeof Empty
      • Readonly kind: Unary
      • Readonly name: "Close"
    • Readonly configure: {
          I: typeof PluginConfiguration;
          O: typeof Empty;
          kind: Unary;
          name: "Configure";
      }

      Configure starts and configures the plugin.

      Generated

      from rpc v1.Plugin.Configure

      • Readonly I: typeof PluginConfiguration
      • Readonly O: typeof Empty
      • Readonly kind: Unary
      • Readonly name: "Configure"
    • Readonly getInfo: {
          I: typeof Empty;
          O: typeof PluginInfo;
          kind: Unary;
          name: "GetInfo";
      }

      GetInfo returns the information for the plugin.

      Generated

      from rpc v1.Plugin.GetInfo

      • Readonly I: typeof Empty
      • Readonly O: typeof PluginInfo
      • Readonly kind: Unary
      • Readonly name: "GetInfo"
  • Readonly typeName: "v1.Plugin"

Generated

from service v1.Plugin

Generated using TypeDoc