functai for TypeScript - v0.1.0
    Preparing search index...

    Class JournalError

    A journal decided a call (streaming.md, "Keeping a log while it is written"). journal-policy: the layers around the tree break the journal policy (refused before it runs). journal-scope: a required journal set only inside a tree. journal-barrier: a required journal did not confirm the events before the code or a tool ran. journal-end: it did not confirm the call's end: outcome is what the call did (what it would have given you, or its error), event names the event that records it, and journal says whether the journal refused it or did not answer (settle() finds out which).

    Hierarchy

    • Error
      • JournalError
    Index
    • Parameters

      • code: JournalCode
      • message: string
      • opts: {
            event?: Position;
            journal?: "unknown" | "refused";
            outcome?: Outcome;
            store?: EventStore;
            tree?: string;
        } = {}

      Returns JournalError

    cause?: unknown
    event?: Position
    journal?: "unknown" | "refused"
    message: string
    name: string
    outcome?: Outcome
    stack?: string
    tree?: 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.

    • For journal-end: read the journal and say what became of the call's end: "kept", "not-kept" (the log is unfinished; final only once you have claimed it) or "another-end" (another writer ended the log). The store did not answer the end, and may not answer this read: signal (AbortSignal.timeout(5000)) stops waiting, rejecting with its reason.

      Parameters

      • opts: { signal?: AbortSignal } = {}

      Returns Promise<"kept" | "not-kept" | "another-end">

    • 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