DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/%40tanstack/namespaces/IR/classes/CollectionRef.md
CollectionRef
Defined in: packages/db/src/query/ir.ts:91
Extends#
- BaseExpression
Constructors#
Constructor#
ts
new CollectionRef(
collection,
alias,
bindingId?): CollectionRef;Defined in: packages/db/src/query/ir.ts:98
Parameters#
collection#
CollectionImpl<any, string | number, any, any, any>
alias#
string
bindingId?#
string
Returns#
CollectionRef
Overrides#
ts
BaseExpression.constructorProperties#
__returnType#
ts
readonly __returnType: any;Defined in: packages/db/src/query/ir.ts:88
Internal
- Type brand for TypeScript inference
Inherited from#
ts
BaseExpression.__returnTypealias#
ts
alias: string;Defined in: packages/db/src/query/ir.ts:96
collection#
ts
collection: CollectionImpl;Defined in: packages/db/src/query/ir.ts:95
type#
ts
type: "collectionRef";Defined in: packages/db/src/query/ir.ts:92
Overrides#
ts
BaseExpression.typeAccessors#
bindingId#
Get Signature#
ts
get bindingId(): string;Defined in: packages/db/src/query/ir.ts:114
Returns#
string
sourceId#
Get Signature#
ts
get sourceId(): string;Defined in: packages/db/src/query/ir.ts:110
Opaque runtime identity; aliases are lexical names only.
Returns#
string