Class ConfigError<ErrorName, Payload>

constructor

• new ConfigError<
      ErrorName extends
          | "optionValidationError"
          | "configValidationError"
          | "httpResponseError"
          | "httpGeneralError"
          | "schemaNotFoundError"
          | "schemasPackageVersionMismatchError"
          | "schemaVersionMismatchError"
          | "promClientNotInstalledError"
          | "serverVersionMismatchError",
      Payload = {
          configValidationError: { code: 2; payload: ValidationError[] };
          httpGeneralError: { code: 4; payload: Error };
          httpResponseError: {
              code: 3;
              payload: Pick<ResponseData, "headers" | "statusCode"> & { body: string };
          };
          optionValidationError: { code: 1; payload: ValidationError[] };
          promClientNotInstalledError: { code: 8; payload: { message: string } };
          schemaNotFoundError: { code: 5; payload: { schemaPath: string } };
          schemasPackageVersionMismatchError: {
              code: 6;
              payload: { localPackageVersion: string; remotePackageVersion: string };
          };
          schemaVersionMismatchError: {
              code: 7;
              payload: { localSchemaVersion: string; remoteSchemaVersion: string };
          };
          serverVersionMismatchError: {
              code: 9;
              payload: {
                  localServerVersion: string;
                  remoteServerVersion: string;
                  satisfies: string;
              };
          };
      }[ErrorName]["payload"],
  >(
      name: ErrorName,
      message: string,
      payload: undefined | Payload,
  ): ConfigError<ErrorName, Payload>

• Creates a new instance of the ConfigError class.

  Type Parameters

  • ErrorName extends
        | "optionValidationError"
        | "configValidationError"
        | "httpResponseError"
        | "httpGeneralError"
        | "schemaNotFoundError"
        | "schemasPackageVersionMismatchError"
        | "schemaVersionMismatchError"
        | "promClientNotInstalledError"
        | "serverVersionMismatchError"
  • Payload = {
        configValidationError: { code: 2; payload: ValidationError[] };
        httpGeneralError: { code: 4; payload: Error };
        httpResponseError: {
            code: 3;
            payload: Pick<ResponseData, "headers" | "statusCode"> & { body: string };
        };
        optionValidationError: { code: 1; payload: ValidationError[] };
        promClientNotInstalledError: { code: 8; payload: { message: string } };
        schemaNotFoundError: { code: 5; payload: { schemaPath: string } };
        schemasPackageVersionMismatchError: {
            code: 6;
            payload: { localPackageVersion: string; remotePackageVersion: string };
        };
        schemaVersionMismatchError: {
            code: 7;
            payload: { localSchemaVersion: string; remoteSchemaVersion: string };
        };
        serverVersionMismatchError: {
            code: 9;
            payload: {
                localServerVersion: string;
                remoteServerVersion: string;
                satisfies: string;
            };
        };
    }[ErrorName]["payload"]

  Parameters

  • name: ErrorName

    The name of the error.
  • message: string

    The error message.
  • payload: undefined | Payload

    The payload associated with the error.

  Returns ConfigError<ErrorName, Payload>

Readonlycode

Readonlypayload