From 6635b463b6418b054c8deac57da78a2970d2166f Mon Sep 17 00:00:00 2001 From: Vincent Date: Mon, 15 Jan 2024 23:05:00 +0100 Subject: [PATCH] Added isKey and getType methods to the documentation --- docs/en/api/preferences.rst | 39 +++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/en/api/preferences.rst b/docs/en/api/preferences.rst index 33fb2b6042e..aae81506aa1 100644 --- a/docs/en/api/preferences.rst +++ b/docs/en/api/preferences.rst @@ -177,6 +177,45 @@ 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. + + +``getType`` +************* + + Returns the type of a key-value pair from the currently open namespace. + + .. code-block:: arduino + + PreferenceType getType(const char * key) + .. + + **Parameters** + * ``key`` (Required) + - the name of the key to be checked. + + **Returns** + * PreferenceType element contaning the type of the key-value pair or PT_INVALID on error. ``putChar, putUChar``