json/doc/mkdocs/docs/api/basic_json/is_object.md
Niels Lohmann 29cd970b94
Consolidate documentation (#3071)
* 🔥 consolidate documentation
* ♻️ overwork std specializations
* 🚚 move images files to mkdocs
* ♻️ fix URLs
* 🔧 tweak MkDocs configuration
* 🔧 add namespaces
* 📝 document deprecations
* 📝 document documentation generation
* 🚸 improve search
* 🚸 add examples
* 🚧 start adding documentation for macros
* 📝 add note for https://github.com/nlohmann/json/issues/874#issuecomment-1001699139
* 📝 overwork example handling
* 📝 fix Markdown tables
2021-12-29 13:41:01 +01:00

664 B

nlohmann::basic_json::is_object

constexpr bool is_object() const noexcept;

This function returns #!cpp true if and only if the JSON value is an object.

Return value

#!cpp true if type is an object, #!cpp false otherwise.

Exception safety

No-throw guarantee: this member function never throws exceptions.

Complexity

Constant.

Examples

??? example

The following code exemplifies `is_object()` for all JSON types.

```cpp
--8<-- "examples/is_object.cpp"
```

Output:

```json
--8<-- "examples/is_object.output"
```

Version history

  • Added in version 1.0.0.