Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

InvalidJoinConditionLeftSourceError.md

220 lines4.3 KB

1---
2id: InvalidJoinConditionLeftSourceError
3title: InvalidJoinConditionLeftSourceError
4---
5​
6# Class: InvalidJoinConditionLeftSourceError
7​
8Defined in: [packages/db/src/errors.ts:564](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L564)
9​
10## Extends
11​
12- [`JoinError`](JoinError.md)
13​
14## Constructors
15​
16### Constructor
17​
18```ts
19new InvalidJoinConditionLeftSourceError(sourceAlias): InvalidJoinConditionLeftSourceError;
20```
21​
22Defined in: [packages/db/src/errors.ts:565](https://github.com/TanStack/db/blob/main/packages/db/src/errors.ts#L565)
23​
24#### Parameters
25​
26##### sourceAlias
27​
28`string`
29​
30#### Returns
31​
32`InvalidJoinConditionLeftSourceError`
33​
34#### Overrides
35​
36[`JoinError`](JoinError.md).[`constructor`](JoinError.md#constructor)
37​
38## Properties
39​
40### cause?
41​
42```ts
43optional cause: unknown;
44```
45​
46Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
47​
48#### Inherited from
49​
50[`JoinError`](JoinError.md).[`cause`](JoinError.md#cause)
51​
52***
53​
54### message
55​
56```ts
57message: string;
58```
59​
60Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
61​
62#### Inherited from
63​
64[`JoinError`](JoinError.md).[`message`](JoinError.md#message)
65​
66***
67​
68### name
69​
70```ts
71name: string;
72```
73​
74Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
75​
76#### Inherited from
77​
78[`JoinError`](JoinError.md).[`name`](JoinError.md#name)
79​
80***
81​
82### stack?
83​
84```ts
85optional stack: string;
86```
87​
88Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
89​
90#### Inherited from
91​
92[`JoinError`](JoinError.md).[`stack`](JoinError.md#stack)
93​
94***
95​
96### stackTraceLimit
97​
98```ts
99static stackTraceLimit: number;
100```
101​
102Defined in: node\_modules/.pnpm/@types+node@25.2.2/node\_modules/@types/node/globals.d.ts:67
103​
104The `Error.stackTraceLimit` property specifies the number of stack frames
105collected by a stack trace (whether generated by `new Error().stack` or
106`Error.captureStackTrace(obj)`).
107​
108The default value is `10` but may be set to any valid JavaScript number. Changes
109will affect any stack trace captured _after_ the value has been changed.
110​
111If set to a non-number value, or set to a negative number, stack traces will
112not capture any frames.
113​
114#### Inherited from
115​
116[`JoinError`](JoinError.md).[`stackTraceLimit`](JoinError.md#stacktracelimit)
117​
118## Methods
119​
120### captureStackTrace()
121​
122```ts
123static captureStackTrace(targetObject, constructorOpt?): void;
124```
125​
126Defined in: node\_modules/.pnpm/@types+node@25.2.2/node\_modules/@types/node/globals.d.ts:51
127​
128Creates a `.stack` property on `targetObject`, which when accessed returns
129a string representing the location in the code at which
130`Error.captureStackTrace()` was called.
131​
132```js
133const myObject = {};
134Error.captureStackTrace(myObject);
135myObject.stack; // Similar to `new Error().stack`
136```
137​
138The first line of the trace will be prefixed with
139`${myObject.name}: ${myObject.message}`.
140​
141The optional `constructorOpt` argument accepts a function. If given, all frames
142above `constructorOpt`, including `constructorOpt`, will be omitted from the
143generated stack trace.
144​
145The `constructorOpt` argument is useful for hiding implementation
146details of error generation from the user. For instance:
147​
148```js
149function a() {
150 b();
152​
153function b() {
154 c();
156​
157function c() {
158 // Create an error without stack trace to avoid calculating the stack trace twice.
159 const { stackTraceLimit } = Error;
160 Error.stackTraceLimit = 0;
161 const error = new Error();
162 Error.stackTraceLimit = stackTraceLimit;
163​
164 // Capture the stack trace above function b
165 Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
166 throw error;
168​
169a();
170```
171​
172#### Parameters
173​
174##### targetObject
175​
176`object`
177​
178##### constructorOpt?
179​
180`Function`
181​
182#### Returns
183​
184`void`
185​
186#### Inherited from
187​
188[`JoinError`](JoinError.md).[`captureStackTrace`](JoinError.md#capturestacktrace)
189​
190***
191​
192### prepareStackTrace()
193​
194```ts
195static prepareStackTrace(err, stackTraces): any;
196```
197​
198Defined in: node\_modules/.pnpm/@types+node@25.2.2/node\_modules/@types/node/globals.d.ts:55
199​
200#### Parameters
201​
202##### err
203​
204`Error`
205​
206##### stackTraces
207​
208`CallSite`[]
209​
210#### Returns
211​
212`any`
213​
214#### See
215​
216https://v8.dev/docs/stack-trace-api#customizing-stack-traces
217​
218#### Inherited from
219​
220[`JoinError`](JoinError.md).[`prepareStackTrace`](JoinError.md#preparestacktrace)