remove

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

• Removes a document.

  import { remove } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  remove(users, '00sHm46UWKObv2W7XK9e').then(() => console.log('Done!'))

  Type parameters

  • Model

  Parameters

  • collection: Collection<Model>

    The collection to remove document in

  • id: string

    The id of the documented to remove

  Returns Promise<void>

  A promise that resolves when the operation is complete

• Removes a document.

  import { remove } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  remove(users, '00sHm46UWKObv2W7XK9e').then(() => console.log('Done!'))

  Type parameters

  • Model

  Parameters

  • ref: Ref<Model>

    The reference to the document to remove

  Returns Promise<void>

  A promise that resolves when the operation is complete