doc

• doc<Model>(ref: Ref<Model>, data: Model): Doc<Model>

• Creates a document object.

  import { doc, ref, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  doc(ref(users, '00sHm46UWKObv2W7XK9e'), { name: 'Sasha' })
  //=> {
  //=>   __type__: 'doc',
  //=>   data: { name: 'Sasha' },
  //=>   ref: {,
  //=>      __type__: 'ref'
  //=>     collection: { __type__: 'collection', path: 'users' },
  //=>     id: '00sHm46UWKObv2W7XK9e'
  //=>   }
  //=> }

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    The document reference

  • data: Model

    The model data

  Returns Doc<Model>

  The document object