📄 tanstack/db/latest/docs/reference/classes/JoinError

File: JoinError.md | Updated: 11/15/2025

Source: https://tanstack.com/db/latest/docs/reference/classes/JoinError

TanStack

DB v0v0

Search...

+ K

Auto

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React logo

React

Version

Latest

Search...

+ K

Getting Started

Guides

Collections

Frameworks

Community

Resources & Packages

core

API Reference

Framework

React logo

React

Version

Latest

Getting Started

Guides

Collections

Frameworks

Community

Resources & Packages

core

API Reference

On this page

JoinError

Copy Markdown

Class: JoinError
================

Defined in: packages/db/src/errors.ts:470

Extends
-------

TanStackDBError

Extended by
-----------

Constructors
------------ ### Constructor

new JoinError(message): JoinError;


new JoinError(message): JoinError;

Defined in: packages/db/src/errors.ts:471

#### Parameters ##### message

string

#### Returns

JoinError

#### Overrides

TanStackDBError .constructor

Properties
---------- ### cause?

optional cause: unknown;


optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3 /node_modules/typescript/lib/lib.es2022.error.d.ts:26

#### Inherited from

TanStackDBError .cause

### message

message: string;


message: string;

Defined in: node_modules/.pnpm/typescript@5.9.3 /node_modules/typescript/lib/lib.es5.d.ts:1077

#### Inherited from

TanStackDBError .message

### name

name: string;


name: string;

Defined in: node_modules/.pnpm/typescript@5.9.3 /node_modules/typescript/lib/lib.es5.d.ts:1076

#### Inherited from

TanStackDBError .name

### stack?

optional stack: string;


optional stack: string;

Defined in: node_modules/.pnpm/typescript@5.9.3 /node_modules/typescript/lib/lib.es5.d.ts:1078

#### Inherited from

TanStackDBError .stack

### stackTraceLimit

static stackTraceLimit: number;


static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@24.7.0 /node_modules/@types/node/globals.d.ts:68

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.

#### Inherited from

TanStackDBError .stackTraceLimit

Methods
------- ### captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;


static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.7.0 /node_modules/@types/node/globals.d.ts:52

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`


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();


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

##### constructorOpt?

Function

#### Returns

void

#### Inherited from

TanStackDBError .captureStackTrace

### prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;


static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.7.0 /node_modules/@types/node/globals.d.ts:56

#### Parameters ##### err

Error

##### stackTraces

CallSite[]

#### Returns

any

#### See

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

#### Inherited from

TanStackDBError .prepareStackTrace

Edit on GitHub

Home

Partners Become a Partner

scarf analytics