onGet

• onGet<Model>(ref: Ref<Model>, onResult: OnResult<Model>, onError?: OnError): function
• onGet<Model>(collection: Collection<Model>, id: string, onResult: OnResult<Model>, onError?: OnError): function

• Subscribes to the diven document.

  import { onGet, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  onGet(users, '00sHm46UWKObv2W7XK9e', sasha => {
    console.log(sasha.ref.id)
    //=> '00sHm46UWKObv2W7XK9e'
    console.log(sasha.data)
    //=> { name: 'Sasha' }
  })

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    The reference to the document

  • onResult: OnResult<Model>

    The function which is called with the document when the initial fetch is resolved or the document updates.

  • Optional onError: OnError

    The function is called with error when request fails.

  Returns function

  Function that unsubscribes the listener from the updates

  • • (): void

    • Returns void

• Subscribes to the diven document.

  import { onGet, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  onGet(users, '00sHm46UWKObv2W7XK9e', sasha => {
    console.log(sasha.ref.id)
    //=> '00sHm46UWKObv2W7XK9e'
    console.log(sasha.data)
    //=> { name: 'Sasha' }
  })

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    The document collection

  • id: string

    The document id

  • onResult: OnResult<Model>

    The function which is called with the document when the initial fetch is resolved or the document updates.

  • Optional onError: OnError

    The function is called with error when request fails.

  Returns function

  Function that unsubscribes the listener from the updates

  • • (): void

    • Returns void