group

• group<A>(path: string, collections: [CollectionEntity<A>]): CollectionGroup<A>
• group<A, B>(path: string, collections: [CollectionEntity<A>, CollectionEntity<B>]): CollectionGroup<A | B>
• group<A, B, C>(path: string, collections: [CollectionEntity<A>, CollectionEntity<B>, CollectionEntity<C>]): CollectionGroup<A | B | C>

• Creates a collection group object.

  import { group, subcollection, collection, ref } from 'typesaurus'
  
  type User = { name: string }
  type Company = { name: string; address: string }
  type Post = { author: Ref<User>; text: string; date?: Date }
  const users = collection<User>('users')
  const companies = collection<Company>('companies')
  const posts = collection<Post>('posts')
  const userPosts = subcollection<Post, User>('posts', users)
  const companyPosts = subcollection<Post, User>('posts', companies)
  
  const allPosts = group('posts', [posts, userPosts, companyPosts])
  //=> { __type__: 'collectionGroup', path: 'posts' }
  
  query(allPosts, [where('author', '==', ref(users, '00sHm46UWKObv2W7XK9e'))])
  //=> Promise<Post[]>

  Type parameters

  • A

  Parameters

  • path: string

  • collections: [CollectionEntity<A>]

    The collections to create group from.

  Returns CollectionGroup<A>

• Creates a collection group object.

  import { group, subcollection, collection, ref } from 'typesaurus'
  
  type User = { name: string }
  type Company = { name: string; address: string }
  type Post = { author: Ref<User>; text: string; date?: Date }
  const users = collection<User>('users')
  const companies = collection<Company>('companies')
  const posts = collection<Post>('posts')
  const userPosts = subcollection<Post, User>('posts', users)
  const companyPosts = subcollection<Post, User>('posts', companies)
  
  const allPosts = group('posts', [posts, userPosts, companyPosts])
  //=> { __type__: 'collectionGroup', path: 'posts' }
  
  query(allPosts, [where('author', '==', ref(users, '00sHm46UWKObv2W7XK9e'))])
  //=> Promise<Post[]>

  Type parameters

  • A

  • B

  Parameters

  • path: string

  • collections: [CollectionEntity<A>, CollectionEntity<B>]

    The collections to create group from.

  Returns CollectionGroup<A | B>

• Creates a collection group object.

  import { group, subcollection, collection, ref } from 'typesaurus'
  
  type User = { name: string }
  type Company = { name: string; address: string }
  type Post = { author: Ref<User>; text: string; date?: Date }
  const users = collection<User>('users')
  const companies = collection<Company>('companies')
  const posts = collection<Post>('posts')
  const userPosts = subcollection<Post, User>('posts', users)
  const companyPosts = subcollection<Post, User>('posts', companies)
  
  const allPosts = group('posts', [posts, userPosts, companyPosts])
  //=> { __type__: 'collectionGroup', path: 'posts' }
  
  query(allPosts, [where('author', '==', ref(users, '00sHm46UWKObv2W7XK9e'))])
  //=> Promise<Post[]>

  Type parameters

  • A

  • B

  • C

  Parameters

  • path: string

  • collections: [CollectionEntity<A>, CollectionEntity<B>, CollectionEntity<C>]

    The collections to create group from.

  Returns CollectionGroup<A | B | C>