Skip to content

Commit 70ce9c3

Browse files
authored
update modification object in ldap.change (ldapjs#910)
* updated the modification object in ldap.change * Adding Change Interface * Modification reference table
1 parent f289008 commit 70ce9c3

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/client.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,8 @@ Example:
213213
const change = new ldap.Change({
214214
operation: 'add',
215215
modification: {
216-
pets: ['cat', 'dog']
216+
type: 'pets',
217+
values: ['cat', 'dog']
217218
}
218219
});
219220

@@ -234,7 +235,13 @@ must be one of:
234235
| add | Adds the attribute value(s) referenced in `modification`. The attribute may or may not already exist. |
235236
| delete | Deletes the attribute (and all values) referenced in `modification`. |
236237

237-
`modification` is just a plain old JS object with the values you want.
238+
`modification` is just a plain old JS object with the required type and values you want.
239+
240+
| Operation | Description |
241+
|-----------|-------------|
242+
| type | String that defines the attribute type for the modification. |
243+
| values | Defines the values for modification. |
244+
238245

239246
# modifyDN
240247
`modifyDN(dn, newDN, controls, callback)`

0 commit comments

Comments
 (0)