@playlive/tiltify-graphql
    Preparing search index...

    Class TiltifyGraphQLError

    Error thrown by TiltifyGraphQL.query for every failure mode: non-2xx HTTP responses, bodies carrying errors[], and bodies missing data.

    The message format is unchanged from the plain Error this replaced, so existing log scrapes and message assertions keep working. What's new is the structured surface:

    • operationName — which operation failed.
    • errors — the raw errors[] entries, untouched.
    • status — HTTP status, when the failure was HTTP-level.
    • isNotFound — whether this means "no such resource."
    try {
      await gql.getFactMilestones(id);
    } catch (err) {
      if (err instanceof TiltifyGraphQLError && err.isNotFound) return null;
      throw err;
    }

    Hierarchy

    • Error
      • TiltifyGraphQLError
    Index
    constructor
    cause? errors isNotFound message name operationName stack? status stackTraceLimit
    toJSON captureStackTrace isError prepareStackTrace
    cause?: unknown

    The cause of the error.

    errors: readonly TiltifyGraphQLErrorEntry[]

    Raw errors[] entries from the response body. Empty for HTTP-level failures.

    isNotFound: boolean

    true when this failure means "the requested resource does not exist" — either an HTTP 404 or a GraphQL error entry Tiltify uses as its not-found marker. Callers should branch on this rather than inspecting message.

    message: string
    name: "TiltifyGraphQLError"
    operationName: string

    GraphQL operation name that produced the failure.

    stack?: string
    status: number | undefined

    HTTP status, when the failure was an HTTP-level one. undefined otherwise.

    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.

    • Structured, log-safe projection. Omits cause and the raw extensions payloads that can carry unbounded upstream detail.

      Returns Record<string, unknown>

    • 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

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Check if a value is an instance of Error

      Parameters

      • value: unknown

        The value to check

      Returns value is Error

      True if the value is an instance of Error, false otherwise

    • Check if a value is an instance of Error

      Parameters

      • value: unknown

        The value to check

      Returns value is Error

      True if the value is an instance of Error, false otherwise

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods