Methods
_computeOptions()
Computes a full options object from an optional opts
object and the ones from this object.schemas
, enrichers
, fetchProperties
and headers
are not merged but the ones from the opts
object
override the ones from this object.
depth() → {Base}
Sets the depth.
Possible values are: root
, children
and max
.
Returns:
The object itself.
- Type
- Base
enricher(entity, name) → {Base}
Adds an enricher for a given entity.
Parameters:
Name | Type | Description |
---|---|---|
entity |
string | The entity name. |
name |
string | The enricher name. |
Returns:
The object itself.
- Type
- Base
enrichers(enrichers) → {Base}
Sets the enrichers.
Parameters:
Name | Type | Description |
---|---|---|
enrichers |
object | The new enrichers. |
Returns:
The object itself.
- Type
- Base
Example
{ document: ['acls', 'permissions'] }
fetchProperties(fetchProperties) → {Base}
Sets the properties to fetch.
Parameters:
Name | Type | Description |
---|---|---|
fetchProperties |
object | The new properties to fetch. |
Returns:
The object itself.
- Type
- Base
Example
{ document: ['dc:creator'] }
fetchProperty(entity, name) → {Base}
Adds a property to fetch for a given entity.
Parameters:
Name | Type | Description |
---|---|---|
entity |
string | The entity name. |
name |
string | The property name. |
Returns:
The object itself.
- Type
- Base
header(name, value) → {Base}
Adds a header.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | the header name |
value |
string | the header value |
Returns:
The object itself..
- Type
- Base
headers(headers) → {Base}
Sets the headers.
Parameters:
Name | Type | Description |
---|---|---|
headers |
object | the new headers. |
Returns:
The object itself.
- Type
- Base
httpTimeout() → {Base}
Sets the HTTP timeout.
Returns:
The object itself.
- Type
- Base
repositoryName(repositoryName) → {Base}
Sets the repository name.
Parameters:
Name | Type | Description |
---|---|---|
repositoryName |
string | The repository name. |
Returns:
The object itself.
- Type
- Base
schemas(schemas) → {Base}
Sets the schemas.
Parameters:
Name | Type | Description |
---|---|---|
schemas |
Array | The schemas. |
Returns:
The object itself.
- Type
- Base
timeout() → {Base}
Sets the global timeout, used as HTTP timeout and transaction timeout
by default.
Returns:
The object itself.
- Type
- Base
transactionTimeout() → {Base}
Sets the transaction timeout.
Returns:
The object itself.
- Type
- Base