@ferrybig/cgeodata-reader
    Preparing search index...

    Class CGeoDataError

    Errors the reader throws because of the data it was given, as opposed to how it was called: a caller's invalid argument (a latitude out of range, a place id this file doesn't have) is a plain RangeError, and anything else is a bug.

    try {
    	reader = CGeoDataReader.open(path);
    } catch (error) {
    	if (error instanceof CGeoDataVersionError) {
    		// written by a newer compressor: upgrade the reader
    	} else if (error instanceof CGeoDataFormatError) {
    		// truncated or corrupt download: fetch the file again
    	} else throw error;
    }

    Hierarchy (View Summary)

    Index
    constructor
    name stackTraceLimit cause? message stack?
    captureStackTrace prepareStackTrace

    • Parameters

      • Optionalmessage: string

      Returns CGeoDataError

    • Parameters

      • Optionalmessage: string
      • Optionaloptions: ErrorOptions

      Returns CGeoDataError

    name: string = "CGeoDataError"

    "CGeoDataError", and each subclass its own name.

    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.

    cause?: unknown
    message: string
    stack?: string

    • 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