Mayson Monorepo Documentation
    Preparing search index...

    The library cannot connect to Stripe. This can happen for a variety of reasons, such as loss of network connectivity or a bad TLS certificate.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    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.

    message: string

    A human-readable message giving more details about the error. For card errors, these messages can be shown to your users.

    rawType: RawErrorType

    See the "error types" section at https://stripe.com/docs/api/errors

    code?: string

    For card errors, a short string describing the kind of card error that occurred.

    doc_url?: string

    A URL to more information about the error code reported.

    statusCode?: number

    Typically a 4xx or 5xx.

    raw: unknown
    headers: { [key: string]: string }
    requestId: string
    param?: string

    The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.

    charge?: string
    decline_code?: string
    payment_intent?: Stripe.PaymentIntent
    payment_method?: Stripe.PaymentMethod
    payment_method_type?: string
    setup_intent?: Stripe.SetupIntent
    source?: Stripe.Source
    type: "StripeConnectionError"
    name: string
    stack?: string

    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