Hierarchy

  • BasePlugin<DashboardPluginConfig>
    • DashboardPlugin

Constructors

Properties

_server: Server<typeof IncomingMessage, typeof ServerResponse>
configSchema: {
    $id: string;
    default: {
        applicationName: string;
        applicationUrl: string;
        host: string;
        port: number;
    };
    properties: {
        applicationName: {
            description: string;
            type: string;
        };
        applicationUrl: {
            description: string;
            format: string;
            type: string;
        };
        host: {
            format: string;
            type: string;
        };
        port: {
            maximum: number;
            minimum: number;
            type: string;
        };
    };
    required: never[];
    type: string;
} = configSchema

Type declaration

  • $id: string
  • default: {
        applicationName: string;
        applicationUrl: string;
        host: string;
        port: number;
    }
    • applicationName: string
    • applicationUrl: string
    • host: string
    • port: number
  • properties: {
        applicationName: {
            description: string;
            type: string;
        };
        applicationUrl: {
            description: string;
            format: string;
            type: string;
        };
        host: {
            format: string;
            type: string;
        };
        port: {
            maximum: number;
            minimum: number;
            type: string;
        };
    }
    • applicationName: {
          description: string;
          type: string;
      }
      • description: string
      • type: string
    • applicationUrl: {
          description: string;
          format: string;
          type: string;
      }
      • description: string
      • format: string
      • type: string
    • host: {
          format: string;
          type: string;
      }
      • format: string
      • type: string
    • port: {
          maximum: number;
          minimum: number;
          type: string;
      }
      • maximum: number
      • minimum: number
      • type: string
  • required: never[]
  • type: string
endpoint?: BasePluginEndpoint
logger: Logger

Accessors

  • get apiClient(): APIClient
  • Returns APIClient

  • get appConfig(): ApplicationConfigForPlugin
  • Returns ApplicationConfigForPlugin

  • get config(): T
  • Returns T

  • get dataPath(): string
  • Returns string

  • get events(): string[]
  • Returns string[]

  • get name(): string
  • Returns string

Methods

  • Parameters

    • context: PluginInitContext<Record<string, unknown>>

    Returns Promise<void>

Generated using TypeDoc