field

• field<Model, Key>(key: Key | [Key], value: Model[Key] | UpdateValue<Model[Key]>): Field<Model>
• field<Model, Key1, Key2>(key: [Key1, Key2], value: Model[Key1][Key2] | UpdateValue<Model[Key1][Key2]>): Field<Model>
• field<Model, Key1, Key2, Key3>(key: [Key1, Key2, Key3], value: Model[Key1][Key2][Key3] | UpdateValue<Model[Key1][Key2][Key3]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4>(key: [Key1, Key2, Key3, Key4], value: Model[Key1][Key2][Key3][Key4] | UpdateValue<Model[Key1][Key2][Key3][Key4]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5>(key: [Key1, Key2, Key3, Key4, Key5], value: Model[Key1][Key2][Key3][Key4][Key5] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5, Key6>(key: [Key1, Key2, Key3, Key4, Key5, Key6], value: Model[Key1][Key2][Key3][Key4][Key5][Key6] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5, Key6, Key7>(key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7], value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8>(key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8], value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9>(key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9], value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9]>): Field<Model>
• field<Model, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9, Key10>(key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9, Key10], value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9][Key10] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9][Key10]>): Field<Model>

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key: keyof Model

  Parameters

  • key: Key | [Key]

    The field key or key path

  • value: Model[Key] | UpdateValue<Model[Key]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  Parameters

  • key: [Key1, Key2]

    The field key or key path

  • value: Model[Key1][Key2] | UpdateValue<Model[Key1][Key2]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  Parameters

  • key: [Key1, Key2, Key3]

    The field key or key path

  • value: Model[Key1][Key2][Key3] | UpdateValue<Model[Key1][Key2][Key3]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  Parameters

  • key: [Key1, Key2, Key3, Key4]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4] | UpdateValue<Model[Key1][Key2][Key3][Key4]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  • Key6: keyof Model[Key1][Key2][Key3][Key4][Key5]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5, Key6]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5][Key6] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  • Key6: keyof Model[Key1][Key2][Key3][Key4][Key5]

  • Key7: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  • Key6: keyof Model[Key1][Key2][Key3][Key4][Key5]

  • Key7: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6]

  • Key8: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  • Key6: keyof Model[Key1][Key2][Key3][Key4][Key5]

  • Key7: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6]

  • Key8: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7]

  • Key9: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9]>

    The value

  Returns Field<Model>

  The field object

• Creates a field object. It's used to update nested maps.

  import { field, update, collection } from 'typesaurus'
  
  type User = { name: string }
  const users = collection<User>('users')
  
  update(users, '00sHm46UWKObv2W7XK9e', [
    field('name', 'Sasha Koss'),
    field(['address', 'city'], 'Dimitrovgrad')
  ])
  //=> Promise<void>

  Type parameters

  • Model

  • Key1: keyof Model

  • Key2: keyof Model[Key1]

  • Key3: keyof Model[Key1][Key2]

  • Key4: keyof Model[Key1][Key2][Key3]

  • Key5: keyof Model[Key1][Key2][Key3][Key4]

  • Key6: keyof Model[Key1][Key2][Key3][Key4][Key5]

  • Key7: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6]

  • Key8: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7]

  • Key9: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8]

  • Key10: keyof Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9]

  Parameters

  • key: [Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8, Key9, Key10]

    The field key or key path

  • value: Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9][Key10] | UpdateValue<Model[Key1][Key2][Key3][Key4][Key5][Key6][Key7][Key8][Key9][Key10]>

    The value

  Returns Field<Model>

  The field object