Objects

Functions for working with dictionaries (NSDictionary).

keys

Returns all keys of a dictionary.

A* result = _.keys(OKV({@"one", N.I(1)}, {@"two", N.I(2)}, {@"three", N.I(3)}));
// => ["one", "two", "three"]

values

Returns all values of a dictionary.

A* result = _.values(OKV({@"one", N.I(1)}, {@"two", N.I(2)}, {@"three", N.I(3)}));
// => [1, 2, 3]

functions

Returns a sorted list of method names.

A* result = _.functions(_);
// => ["all", "any", "bind", ...]

Alias: methods

extend

Copies all properties from source objects to the destination.

O* result = _.extend(OKV({@"name", @"moe"}), OKV({@"age", N.I(50)}));
// => {name: "moe", age: 50}

pick

Returns a copy with only the specified keys.

O* result = _.pick(OKV({@"name", @"moe"}, {@"age", N.I(50)}, {@"userid", @"moe1"}), @"name", @"age");
// => {name: "moe", age: 50}

defaults

Fills in missing properties with default values.

O* iceCream = OKV({@"flavor", @"chocolate"});
O* result = _.defaults(iceCream, OKV({@"flavor", @"vanilla"}, {@"sprinkles", @"lots"}));
// => {flavor: "chocolate", sprinkles: "lots"}

clone

Creates a shallow copy.

O* clone = _.clone(OKV({@"name", @"moe"}));

tap

Invokes a block with the object, then returns the object.

O* result = _.chain(OKV({@"a", N.I(1)}))
    .tap(^(O* obj) { NSLog(@"%@", obj); })
    .value();

has

Returns YES if the key is present.

B result = _.has(OKV({@"a", N.I(1)}, {@"b", N.I(2)}), @"b");
// => YES

isEqual

Performs deep comparison.

O* stooge = OKV({@"name", @"moe"}, {@"luckyNumbers", AI(13, 27, 34)});
O* clone = OKV({@"name", @"moe"}, {@"luckyNumbers", AI(13, 27, 34)});
B result = _.isEqual(stooge, clone);
// => YES

isEmpty

Returns YES if the object contains no values.

B result = _.isEmpty(AI());
// => YES

isArray

Returns YES if the object is an array.

B result = _.isArray(AI(1, 2, 3));
// => YES

isObject

Returns YES if the object is a dictionary.

B result = _.isObject(OKV({@"a", N.I(1)}));
// => YES

isString

Returns YES if the object is a string.

B result = _.isString(@"moe");
// => YES

isNumber

Returns YES if the object is a number.

B result = _.isNumber(N.I(8) * N.I(4) / N.I(2));
// => YES

isBoolean

Returns YES if the object is a boolean.

B result = _.isBoolean(nil);
// => NO

isDate

Returns YES if the object is a date.

B result = _.isDate([NSDate date]);
// => YES

isNaN

Returns YES if the object is NaN.

B result = _.isNaN(NAN);
// => YES

isNull

Returns YES if the object is nil.

B result = _.isNull(nil);
// => YES

isFunction

Returns YES if the object is a block.

B result = _.isFunction(^{ return @"hi"; });
// => YES

isFinite

Returns YES if the number is finite.

B result = _.isFinite(N.I(100));
// => YES

isArguments

Returns YES if the object is an arguments array.

B result = _.isArguments(args);
// => YES

_.m Extensions

These functions are specific to _.m:

isTruthy

Returns YES for non-nil, non-empty values.

B result = _.isTruthy(@"hello");
// => YES

isFalsy

Returns YES for nil or empty values.

B result = _.isFalsy(@"");
// => YES

isDictionary

Returns YES if the value is an NSDictionary.

B result = _.isDictionary(OKV({@"a", N.I(1)}));
// => YES

isBlock

Returns YES if the value is a block.

B result = _.isBlock(^{ });
// => YES

valueTester

Creates a predicate that tests a property value.

_ItemTestBlock tester = _.valueTester(@"name", @"moe");
B result = tester(OKV({@"name", @"moe"}));
// => YES

valueStringTester

Creates a predicate that tests a string property.

_ItemTestBlock tester = _.valueStringTester(@"name", @"moe");

setProps

Sets a property on all elements in an array.

_.setProps(items, @"selected", @YES);

classNames

Returns an array of class names for an object’s class hierarchy.

A* names = _.classNames(myObject);
// => ["MyClass", "MySuperClass", "NSObject"]