Skip to content

Commit

Permalink
Added isKey documentation for the Preferences library (#9142)
Browse files Browse the repository at this point in the history
* Added isKey and getType methods to the documentation (#9111)

* Removed duplicated getType documentation.
  • Loading branch information
Viproz authored Jan 19, 2024
1 parent 5bf60b7 commit 7c344cc
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/source/api/preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,27 @@ Arduino-esp32 Preferences API

**Note**
* A message providing the reason for a failed call is sent to the arduino-esp32 ``log_e`` facility.


``isKey``
*************

Check if a key-value pair from the currently open namespace exists.

.. code-block:: arduino
bool isKey(const char * key)
..
**Parameters**
* ``key`` (Required)
- the name of the key to be checked.

**Returns**
* ``true`` if key-value pair exists; ``false`` otherwise.

**Note**
* Attempting to check a key without a namespace being open will return false.


``putChar, putUChar``
Expand Down

0 comments on commit 7c344cc

Please sign in to comment.