ldapts
Advanced tools
Comparing version 2.0.0 to 2.0.1
@@ -0,1 +1,4 @@ | ||
| ### 2.0.1 | ||
| * Documentation updates | ||
| ### 2.0.0 | ||
@@ -2,0 +5,0 @@ * Drop support for nodejs v8 |
| { | ||
| "name": "ldapts", | ||
| "version": "2.0.0", | ||
| "version": "2.0.1", | ||
| "description": "LDAP client", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -72,5 +72,7 @@ LDAPts | ||
| `dn (string)`: The name (DN) of the directory object that the client wishes to bind as | ||
| `password (string)`: Password for the target bind DN | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`dn` (string)|The name (DN) of the directory object that the client wishes to bind as | ||
| |`password` (string)|Password for the target bind DN | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -91,5 +93,7 @@ Example: | ||
| `dn (string)`: The DN of the entry to add | ||
| `entry (object|Attribute[])`: The set of attributes to include in that entry | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`dn` (string)|The DN of the entry to add | ||
| |`entry` (object|Attribute[])|The set of attributes to include in that entry | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -114,6 +118,8 @@ Example: | ||
| `dn (string)`: The DN of the entry in which the comparison is to be made | ||
| `attribute (string)`: The Name of the attribute in which the comparison is to be made | ||
| `value (string)`: The Attribute Value Assertion to try to find in the specified attribute | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`dn` (string)|The DN of the entry in which the comparison is to be made | ||
| |`attribute` (string)|The Name of the attribute in which the comparison is to be made | ||
| |`value` (string)|The Attribute Value Assertion to try to find in the specified attribute | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -134,4 +140,6 @@ Returns: | ||
| `dn (string)`: The DN of the entry to delete | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| `dn` (string)|The DN of the entry to delete | ||
| `[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -149,5 +157,7 @@ Example: | ||
| `oid (string)`: Object identifier representing the type of request | ||
| `[value] (string)`: Optional value - based on the type of operation | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`oid` (string)|Object identifier representing the type of request | ||
| |`[value]` (string)|Optional value - based on the type of operation | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -168,5 +178,7 @@ | ||
| `dn (string)`: The DN of the entry to modify | ||
| `changes (Change|Change[])`: The set of changes to make to the entry | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| `dn` (string)|The DN of the entry to modify | ||
| `changes` (Change|Change[])|The set of changes to make to the entry | ||
| `[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -204,13 +216,13 @@ | ||
| A `Change` object maps to the LDAP protocol of a modify change, and requires you | ||
| to set the `operation` and `modification`. The `operation` is a string, and | ||
| must be one of: | ||
| to set the `operation` and `modification`. | ||
| ||replace||Replaces the attribute referenced in `modification`. If the modification has no values, it is equivalent to a delete.|| | ||
| ||add||Adds the attribute value(s) referenced in `modification`. The attribute may or may not already exist.|| | ||
| ||delete||Deletes the attribute (and all values) referenced in `modification`.|| | ||
| Arguments: | ||
| `operation (replace|add|delete)`: | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`operation` (replace|add|delete)|*See table below* | ||
| |`modification` (Attribute)|Attribute details to add, remove, or update | ||
| Operations: | ||
| | Value | Description | ||
@@ -222,4 +234,2 @@ | --------- | ------------ | ||
| `modification (Attribute)`: Attribute details to add, remove, or update | ||
| ## modifyDN | ||
@@ -239,5 +249,7 @@ `modifyDN(dn, newDN, [controls])` | ||
| `dn (string)`: The DN of the entry to rename | ||
| `newDN (string)`: The new RDN to use assign to the entry. It may be the same as the current RDN if you only intend to move the entry beneath a new parent. If the new RDN includes any attribute values that aren’t already in the entry, the entry will be updated to include them. | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`dn` (string)|The DN of the entry to rename | ||
| |`newDN` (string)|The new RDN to use assign to the entry. It may be the same as the current RDN if you only intend to move the entry beneath a new parent. If the new RDN includes any attribute values that aren’t already in the entry, the entry will be updated to include them. | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
@@ -259,5 +271,10 @@ | ||
| `baseDN (string)`: The base of the subtree in which the search is to be constrained | ||
| `options (object)`: | ||
| |Argument |Description | ||
| |---------|-------------- | ||
| |`baseDN` (string)|The base of the subtree in which the search is to be constrained | ||
| |`options` (object)|*See table below* | ||
| |`[controls]` (Control|Control[])|Optional `Control` object or array of `Control` objects | ||
| Options: | ||
| |Attribute |Description | ||
@@ -272,5 +289,4 @@ |-----------------------------------------------|---------------------------------------------------| | ||
| |[paged=false] (boolean|SearchPageOptions) |Used to allow paging and specify the page size | ||
| |[attributes=] (string[]) |A set of attributes to request for inclusion in entries that match the search criteria and are returned to the client. If a specific set of attribute descriptions are listed, then only those attributes should be included in matching entries. The special value “*” indicates that all user attributes should be included in matching entries. The special value “+” indicates that all operational attributes should be included in matching entries. The special value “1.1” indicates that no attributes should be included in matching entries. Some servers may also support the ability to use the “@” symbol followed by an object class name (e.g., “@inetOrgPerson”) to request all attributes associated with that object class. If the set of attributes to request is empty, then the server should behave as if the value “*” was specified to request that all user attributes be included in entries that are returned. | ||
| |[attributes=] (string[]) |A set of attributes to request for inclusion in entries that match the search criteria and are returned to the client. If a specific set of attribute descriptions are listed, then only those attributes should be included in matching entries. The special value “*” indicates that all user attributes should be included in matching entries. The special value “+” indicates that all operational attributes should be included in matching entries. The special value “1.1” indicates that no attributes should be included in matching entries. Some servers may also support the ability to use the “@” symbol followed by an object class name (e.g., “@inetOrgPerson”) to request all attributes associated with that object class. If the set of attributes to request is empty, then the server should behave as if the value “*” was specified to request that all user attributes be included in entries that are returned. | ||
| `[controls] (Control|Control[])`: Optional `Control` object or array of `Control` objects | ||
@@ -277,0 +293,0 @@ |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.05%
315124
- Number of lines in readme file
- increased by3.86%
431
No dependency changes