@map-colonies/config
    Preparing search index...

    Class ConfigError<ErrorName, Payload>

    Represents an error specific to the configuration module.

    Type Parameters

    Hierarchy

    • Error
      • ConfigError
    Index

    Constructors

    constructor

    Properties

    cause? code message name payload stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Creates a new instance of the ConfigError class.

      Type Parameters

      • ErrorName extends
            | "optionValidationError"
            | "configValidationError"
            | "httpResponseError"
            | "httpGeneralError"
            | "schemaNotFoundError"
            | "schemasPackageVersionMismatchError"
            | "schemaVersionMismatchError"
            | "promClientNotInstalledError"
            | "serverVersionMismatchError"

        The name of the error.

      • Payload = {
            configValidationError: { code: 2; payload: ValidationError[] };
            httpGeneralError: { code: 4; payload: Error };
            httpResponseError: {
                code: 3;
                payload: Pick<ResponseData<null>, "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"]

        The payload type associated with the error.

      Parameters

      • name: ErrorName

        The name of the error.

      • message: string

        The error message.

      • payload: Payload | undefined

        The payload associated with the error.

      Returns ConfigError<ErrorName, Payload>

    Properties

    cause?: unknown
    code: {
        configValidationError: { code: 2; payload: ValidationError[] };
        httpGeneralError: { code: 4; payload: Error };
        httpResponseError: {
            code: 3;
            payload: Pick<ResponseData<null>, "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]["code"]
    message: string
    name: string
    payload: Payload | undefined

    The payload associated with the error.

    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods