update

• update<Model>(collection: Collection<Model>, id: string, data: Field<Model>[]): Promise<void>
• update<Model>(ref: Ref<Model>, data: Field<Model>[]): Promise<void>
• update<Model>(collection: Collection<Model>, id: string, data: UpdateModel<Model>): Promise<void>
• update<Model>(ref: Ref<Model>, data: UpdateModel<Model>): Promise<void>

• Updates a document.

  import { update, field, collection } from 'typesaurus'
  
  type User = {
    name: string,
    address: {
      country: string,
      city: string
    }
  }
  
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', { name: 'Sasha Koss' })
    .then(() => console.log('Done!'))
  // or using key paths:
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Moscow')
  ])

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    the collection to update document in

  • id: string

    the id of the document to update

  • data: Field<Model>[]

    the document data to update

  Returns Promise<void>

  A promise that resolves when the operation is finished

• Updates a document.

  import { update, field, collection } from 'typesaurus'
  
  type User = {
    name: string,
    address: {
      country: string,
      city: string
    }
  }
  
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', { name: 'Sasha Koss' })
    .then(() => console.log('Done!'))
  // or using key paths:
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Moscow')
  ])

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    the reference to the document to set

  • data: Field<Model>[]

    the document data to update

  Returns Promise<void>

  A promise that resolves when the operation is finished

• Updates a document.

  import { update, field, collection } from 'typesaurus'
  
  type User = {
    name: string,
    address: {
      country: string,
      city: string
    }
  }
  
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', { name: 'Sasha Koss' })
    .then(() => console.log('Done!'))
  // or using key paths:
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Moscow')
  ])

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    the collection to update document in

  • id: string

    the id of the document to update

  • data: UpdateModel<Model>

    the document data to update

  Returns Promise<void>

  A promise that resolves when the operation is finished

• Updates a document.

  import { update, field, collection } from 'typesaurus'
  
  type User = {
    name: string,
    address: {
      country: string,
      city: string
    }
  }
  
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', { name: 'Sasha Koss' })
    .then(() => console.log('Done!'))
  // or using key paths:
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Moscow')
  ])

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    the reference to the document to set

  • data: UpdateModel<Model>

    the document data to update

  Returns Promise<void>

  A promise that resolves when the operation is finished