mirror of
https://github.com/nlohmann/json.git
synced 2025-07-29 23:01:16 +03:00
📝 add more API documentation
This commit is contained in:
50
doc/mkdocs/docs/api/basic_json/is_number.md
Normal file
50
doc/mkdocs/docs/api/basic_json/is_number.md
Normal file
@ -0,0 +1,50 @@
|
||||
# basic_json::is_number
|
||||
|
||||
```cpp
|
||||
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
|
||||
|
||||
```cpp
|
||||
constexpr bool is_number() const noexcept
|
||||
{
|
||||
return is_number_integer() || is_number_float();
|
||||
}
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
??? example
|
||||
|
||||
The following code exemplifies `is_number()` for all JSON types.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/is_number.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/is_number.output"
|
||||
```
|
||||
|
||||
## Version history
|
||||
|
||||
- Added in version 1.0.0.
|
||||
- Extended to also return `#!cpp true` for unsigned integers in 2.0.0.
|
Reference in New Issue
Block a user