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

JoinCollectionNotFoundError.md

218 lines4.5 KB

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