json/doc/mkdocs/docs/api/basic_json/is_number.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

1.3 KiB

nlohmann::basic_json::is_number

constexpr bool is_number() const noexcept;

This function returns #!cpp true if and only if the JSON value is a number. This includes both integer (signed and unsigned) and floating-point values.

Return value

#!cpp true if type is number (regardless whether integer, unsigned integer or floating-type), #!cpp false otherwise.

Exception safety

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

Complexity

Constant.

Possible implementation

constexpr bool is_number() const noexcept
{
    return is_number_integer() || is_number_float();
}

Examples

??? example

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

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

Output:

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

See also

Version history

  • Added in version 1.0.0.
  • Extended to also return #!cpp true for unsigned integers in 2.0.0.