[GitHub] janpio closed pull request #162: CB-13693: Improves Documentation

[GitBox <gi...@apache.org>]

janpio closed pull request #162: CB-13693: Improves Documentation
URL: https://github.com/apache/cordova-plugin-contacts/pull/162
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/README.md b/README.md
index 454a028..3e7520a 100644
--- a/README.md
+++ b/README.md
@@ -165,10 +165,10 @@ device contacts database and returning an array of `Contact` objects.
 The resulting objects are passed to the `contactSuccess` callback
 function specified by the __contactSuccess__ parameter.
 
-The __contactFields__ parameter specifies the fields to be used as a
-search qualifier.  A zero-length __contactFields__ parameter is invalid and results in
-`ContactError.INVALID_ARGUMENT_ERROR`. A __contactFields__ value of
-`"*"` searches all contact fields.
+The __contactFields__ parameter should always be an array and specifies the
+fields to be used as a search qualifier.  A zero-length __contactFields__
+parameter is invalid and results in `ContactError.INVALID_ARGUMENT_ERROR`.
+A __contactFields__ value of `["*"]` searches all contact fields.
 
 The __contactFindOptions.filter__ string can be used as a search
 filter when querying the contacts database.  If provided, a
diff --git a/types/index.d.ts b/types/index.d.ts
index f0979ba..3812c70 100644
--- a/types/index.d.ts
+++ b/types/index.d.ts
@@ -23,9 +23,9 @@ interface Contacts {
      * The navigator.contacts.find method executes asynchronously, querying the device contacts database
      * and returning an array of Contact objects. The resulting objects are passed to the onSuccess
      * callback function specified by the onSuccess parameter.
-     * @param fields The fields parameter specifies the fields to be used as a search qualifier,
-     * and only those results are passed to the onSuccess callback function. A zero-length fields parameter
-     * is invalid and results in ContactError.INVALID_ARGUMENT_ERROR. A contactFields value of "*" returns all contact fields.
+     * @param fields The fields parameter should always be an array and specifies the fields to be used
+     * as a search qualifier.  A zero-length fields parameter is invalid and results in ContactError.INVALID_ARGUMENT_ERROR.
+     * A fields value of ["*"] searches all contact fields.
      * @param onSuccess Success callback function invoked with the array of Contact objects returned from the database
      * @param onError Error callback function, invoked when an error occurs.
      * @param options Search options to filter navigator.contacts.


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org