| # PropertyLValue |
| |
| The `Napi::Object::PropertyLValue` class is a helper class provided by |
| `Napi::Object` to allow more intuitive assignment of properties. |
| |
| ## Example |
| ```cpp |
| #include <napi.h> |
| |
| using namespace Napi; |
| |
| Void Init(Env env) { |
| // Create a new instance |
| Object obj = Object::New(env); |
| |
| // Assign a value to a property. |
| obj["hello"] = "world"; |
| } |
| ``` |
| |
| In the above example, `obj["hello"]` returns a `Napi::Object::PropertyLValue` |
| whose `operator=()` method accepts a string which will become the value of the |
| "hello" property of the newly created object. |
| |
| In general, `obj[key] = value` is the equivalent of `obj.Set(key, value)`, where |
| the types of `key` and `value` are all those supported by |
| [`Napi::Object::Set()`](object.md#set). |
| |
| ## Methods |
| |
| ### operator Value() |
| |
| ```cpp |
| operator Value() const; |
| ``` |
| |
| Implicitly casts this `Napi::Object::PropertyLValue` to a `Napi::Value`. |
| |
| ### operator =() |
| |
| ```cpp |
| template <typename ValueType> |
| PropertyLValue& operator =(ValueType value); |
| ``` |
| |
| * `[in] value` a value to assign to the property referred to by the |
| `Napi::Object::PropertyLValue`. The type of the value is one of the types |
| supported by the second parameter of [`Napi::Object::Set()`](object.md#set). |
| |
| Returns a self-reference. |