upset

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

• Sets a document to the given data or updates if it exists.

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

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    the reference to the document to set or update

  • data: UpsetModel<Model>

    the document data

  Returns Promise<void>

• Sets a document to the given data or updates if it exists.

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

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    the collection to set or update

  • id: string

    the id of the document to set or update

  • data: UpsetModel<Model>

    the document data

  Returns Promise<void>