Hierarchy

  • BasePlugin<MonitorPluginConfig>
    • MonitorPlugin

Constructors

Properties

_app: Express
_server: Server<typeof IncomingMessage, typeof ServerResponse>
_state: SharedState
configSchema: {
    $id: string;
    default: {
        cors: {
            methods: string[];
            origin: string;
        };
        host: string;
        limits: {
            delayAfter: number;
            delayMs: number;
            headersTimeout: number;
            max: number;
            serverSetTimeout: number;
            windowMs: number;
        };
        port: number;
        whiteList: string[];
    };
    properties: {
        cors: {
            properties: {
                methods: {
                    type: string;
                };
                origin: {
                    anyOf: {
                        type: string;
                    }[];
                };
            };
            required: string[];
            type: string;
        };
        host: {
            format: string;
            type: string;
        };
        limits: {
            properties: {
                delayAfter: {
                    type: string;
                };
                delayMs: {
                    type: string;
                };
                headersTimeout: {
                    maximum: number;
                    minimum: number;
                    type: string;
                };
                max: {
                    type: string;
                };
                serverSetTimeout: {
                    maximum: number;
                    minimum: number;
                    type: string;
                };
                windowMs: {
                    type: string;
                };
            };
            required: string[];
            type: string;
        };
        port: {
            maximum: number;
            minimum: number;
            type: string;
        };
        whiteList: {
            items: {
                type: string;
            };
            type: string;
        };
    };
    required: string[];
    type: string;
} = configSchema

Type declaration

  • $id: string
  • default: {
        cors: {
            methods: string[];
            origin: string;
        };
        host: string;
        limits: {
            delayAfter: number;
            delayMs: number;
            headersTimeout: number;
            max: number;
            serverSetTimeout: number;
            windowMs: number;
        };
        port: number;
        whiteList: string[];
    }
    • cors: {
          methods: string[];
          origin: string;
      }
      • methods: string[]
      • origin: string
    • host: string
    • limits: {
          delayAfter: number;
          delayMs: number;
          headersTimeout: number;
          max: number;
          serverSetTimeout: number;
          windowMs: number;
      }
      • delayAfter: number
      • delayMs: number
      • headersTimeout: number
      • max: number
      • serverSetTimeout: number
      • windowMs: number
    • port: number
    • whiteList: string[]
  • properties: {
        cors: {
            properties: {
                methods: {
                    type: string;
                };
                origin: {
                    anyOf: {
                        type: string;
                    }[];
                };
            };
            required: string[];
            type: string;
        };
        host: {
            format: string;
            type: string;
        };
        limits: {
            properties: {
                delayAfter: {
                    type: string;
                };
                delayMs: {
                    type: string;
                };
                headersTimeout: {
                    maximum: number;
                    minimum: number;
                    type: string;
                };
                max: {
                    type: string;
                };
                serverSetTimeout: {
                    maximum: number;
                    minimum: number;
                    type: string;
                };
                windowMs: {
                    type: string;
                };
            };
            required: string[];
            type: string;
        };
        port: {
            maximum: number;
            minimum: number;
            type: string;
        };
        whiteList: {
            items: {
                type: string;
            };
            type: string;
        };
    }
    • cors: {
          properties: {
              methods: {
                  type: string;
              };
              origin: {
                  anyOf: {
                      type: string;
                  }[];
              };
          };
          required: string[];
          type: string;
      }
      • properties: {
            methods: {
                type: string;
            };
            origin: {
                anyOf: {
                    type: string;
                }[];
            };
        }
        • methods: {
              type: string;
          }
          • type: string
        • origin: {
              anyOf: {
                  type: string;
              }[];
          }
          • anyOf: {
                type: string;
            }[]
      • required: string[]
      • type: string
    • host: {
          format: string;
          type: string;
      }
      • format: string
      • type: string
    • limits: {
          properties: {
              delayAfter: {
                  type: string;
              };
              delayMs: {
                  type: string;
              };
              headersTimeout: {
                  maximum: number;
                  minimum: number;
                  type: string;
              };
              max: {
                  type: string;
              };
              serverSetTimeout: {
                  maximum: number;
                  minimum: number;
                  type: string;
              };
              windowMs: {
                  type: string;
              };
          };
          required: string[];
          type: string;
      }
      • properties: {
            delayAfter: {
                type: string;
            };
            delayMs: {
                type: string;
            };
            headersTimeout: {
                maximum: number;
                minimum: number;
                type: string;
            };
            max: {
                type: string;
            };
            serverSetTimeout: {
                maximum: number;
                minimum: number;
                type: string;
            };
            windowMs: {
                type: string;
            };
        }
        • delayAfter: {
              type: string;
          }
          • type: string
        • delayMs: {
              type: string;
          }
          • type: string
        • headersTimeout: {
              maximum: number;
              minimum: number;
              type: string;
          }
          • maximum: number
          • minimum: number
          • type: string
        • max: {
              type: string;
          }
          • type: string
        • serverSetTimeout: {
              maximum: number;
              minimum: number;
              type: string;
          }
          • maximum: number
          • minimum: number
          • type: string
        • windowMs: {
              type: string;
          }
          • type: string
      • required: string[]
      • type: string
    • port: {
          maximum: number;
          minimum: number;
          type: string;
      }
      • maximum: number
      • minimum: number
      • type: string
    • whiteList: {
          items: {
              type: string;
          };
          type: string;
      }
      • items: {
            type: string;
        }
        • type: string
      • type: string
  • required: string[]
  • type: string
endpoint: Endpoint = ...
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

    • header: {
          height: number;
          id: string;
          [key: string]: unknown;
      }
      • [key: string]: unknown
      • height: number
      • id: string

    Returns void

  • Parameters

    • header: {
          height: number;
          id: string;
          [key: string]: unknown;
      }
      • [key: string]: unknown
      • height: number
      • id: string

    Returns void

Generated using TypeDoc