Module object/pathEq

pathEq

• pathEq(path: Paths, val: any, obj: any): boolean
• pathEq(path: Paths, val: any): (obj: any) => boolean
• pathEq(path: Paths): CurriedFunction2<any, any, boolean>

• Determines whether a nested path on an object has a specific value

  example

   var user1 = { address: { zipCode: 90210 } };
   var user2 = { address: { zipCode: 55555 } };
   var user3 = { name: 'Bob' };
   var users = [ user1, user2, user3 ];
   var isFamous = pathEq(['address', 'zipCode'], 90210);
   filter(isFamous, users); //=> [ user1 ]
  

  Parameters

  • path: Paths

  • val: any

  • obj: any

    The object to check the nested property in

  Returns boolean

  true if the value is the nested object property, false otherwise.

• Determines whether a nested path on an object has a specific value

  example

   var user1 = { address: { zipCode: 90210 } };
   var user2 = { address: { zipCode: 55555 } };
   var user3 = { name: 'Bob' };
   var users = [ user1, user2, user3 ];
   var isFamous = pathEq(['address', 'zipCode'], 90210);
   filter(isFamous, users); //=> [ user1 ]
  

  Parameters

  • path: Paths

  • val: any

  Returns (obj: any) => boolean

  true if the value is the nested object property, false otherwise.

  • • (obj: any): boolean

    • Parameters

      • obj: any

      Returns boolean

• Determines whether a nested path on an object has a specific value

  example

   var user1 = { address: { zipCode: 90210 } };
   var user2 = { address: { zipCode: 55555 } };
   var user3 = { name: 'Bob' };
   var users = [ user1, user2, user3 ];
   var isFamous = pathEq(['address', 'zipCode'], 90210);
   filter(isFamous, users); //=> [ user1 ]
  

  Parameters

  • path: Paths

  Returns CurriedFunction2<any, any, boolean>

  true if the value is the nested object property, false otherwise.