set

• set<Model>(ref: Ref<Model>, data: SetModel<Model>): Promise<void>
• set<Model>(collection: Collection<Model>, id: string, data: SetModel<Model>): Promise<void>

• Sets a document to the given data.

  import { set, get, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  const userId = '00sHm46UWKObv2W7XK9e'
  await set(users, userId, { name: 'Sasha Koss' })
  console.log(await get(users, userId))
  //=> { name: 'Sasha Koss' }

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    the reference to the document to set

  • data: SetModel<Model>

    the document data

  Returns Promise<void>

• Sets a document to the given data.

  import { set, get, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  const userId = '00sHm46UWKObv2W7XK9e'
  await set(users, userId, { name: 'Sasha Koss' })
  console.log(await get(users, userId))
  //=> { name: 'Sasha Koss' }

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    the collection to set document in

  • id: string

    the id of the document to set

  • data: SetModel<Model>

    the document data

  Returns Promise<void>