Skip to main content
Version: Next

ActorInputError

Thrown by Actor.getInput when the Actor input cannot be produced. code says why, and cause carries the underlying error where there is one. Anything else thrown by getInput(), such as an Apify API error, is not an input problem and is passed through as is.

try {
    input = await Actor.getInput();
} catch (error) {
    if (!(error instanceof ActorInputError) || error.code !== 'NOT_FOUND') throw error;
    input = {};
}

Hierarchy

  • Error
    • ActorInputError

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

externaloptionalinheritedcause

cause?: unknown

readonlycode

code: ActorInputErrorCode

externalinheritedmessage

message: string

readonlyname

name: ActorInputError = 'ActorInputError'

externaloptionalinheritedstack

stack?: string

staticexternalinheritedstackTraceLimit

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

staticexternalinheritedcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt): void

  • 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

    • externaltargetObject: object
    • externaloptionalconstructorOpt: Function

    Returns void

staticexternalinheritedisError

  • isError(error): error is Error

  • Indicates whether the argument provided is a built-in Error instance or not.

    Parameters

    • externalerror: unknown

    Returns error is Error

staticexternalinheritedprepareStackTrace

  • prepareStackTrace(err, stackTraces): any
Page Options