Skip to content

routier-collection


routier-collection / datastore/src / CollectionRef

Type Alias: CollectionRef<TInner> ​

CollectionRef<TInner> = object

Defined in: datastore/src/collections/types.ts:111

A collection or view, seen as the inner side of a join.

Structural rather than CollectionBase<TInner> so the queryables can name it without importing the collection they are built by. Views satisfy it because they extend CollectionBase — which is a requirement, not a bonus: full-text search joins its index view to its source collection.

Type Parameters ​

TInner ​

TInner extends object

Methods ​

joinSide() ​

joinSide(): JoinSide<TInner>

Defined in: datastore/src/collections/types.ts:112

Returns ​

JoinSide<TInner>

Released under the MIT License.