Skip to content

Commit f5f49fd

Browse files
committed
docs: fix missing param in getContactsByName
1 parent ac69405 commit f5f49fd

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,8 @@ console.log(allContacts[0])
9898

9999
### `contacts.getContactsByName(name[, extraProperties])`
100100

101-
* `extraProperties` string[] (optional) - an array of extra contact properties to fetch that can be any of: `jobTitle`, `departmentName`, `organizationName`, `middleName`, `note`, `contactImage`, `contactThumbnailImage`, `instantMessageAddresses`, or `socialProfiles`.
101+
* `name` String (required) - The first, middle, last, or full name of a contact.
102+
* `extraProperties` String[] (optional) - an array of extra contact properties to fetch that can be any of: `jobTitle`, `departmentName`, `organizationName`, `middleName`, `note`, `contactImage`, `contactThumbnailImage`, `instantMessageAddresses`, or `socialProfiles`.
102103

103104
Returns `Array<Object>` - Returns an array of contact objects where either the first or last name of the contact matches `name`.
104105

@@ -179,7 +180,7 @@ console.log(`New contact was ${success ? 'saved' : 'not saved'}.`)
179180

180181
### `contacts.deleteContact(name)`
181182

182-
* `name` String (required) - The first, last, or full name of a contact.
183+
* `name` String (required) - The first, middle, last, or full name of a contact.
183184

184185
Returns `Boolean` - whether the contact was deleted successfully.
185186

0 commit comments

Comments
 (0)