get

• get<Model>(ref: Ref<Model>): Promise<Doc<Model> | null>
• get<Model>(collection: Collection<Model>, id: string): Promise<Doc<Model> | null>

• Retrieves a document from a collection.

  import { transaction, collection } from 'typesaurus'
  
  type Counter = { count: number }
  const counters = collection<Counter>('counters')
  
  transaction(
    ({ get }) => get('420'),
    //=> { __type__: 'doc', data: { count: 42 }, ... }
    ({ data: counter, set }) =>
      set(counter.ref, { count: counter.data.count + 1 })
  )

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    The reference to the document

  Returns Promise<Doc<Model> | null>

  Promise to the document or null if not found

• Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    The collection to get document from

  • id: string

    The document id

  Returns Promise<Doc<Model> | null>