Extends
Members
(readonly) has :Object
A dictionary with functionality of the registry (e.g. registry.has.schemes).
- Object
- Inherited From
languages :Array.<string>
A list of RFC 3066 language tags in lowercase in order of priority.
- Array.<string>
- Inherited From
Methods
(async) deleteMapping(config, mapping) → {boolean}
Removes a mapping from local storage.
| Name | Type | Description |
|---|---|---|
config | Object | |
mapping | Object | JSKOS mapping |
boolean whether deleting the mapping was successful
- Type:
- boolean
(async) deleteMappings(config) → {Array.<Object>}
DELETEs multiple mappings. Do not override in subclass!
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
- Inherited From
array of results (true if successful); in case of failure, consult the _errors property on the array at the index of the failed request
- Type:
- Array.<Object>
getCancelTokenSource() → {Object}
Returns a source for a axios cancel token.
- Inherited From
axios cancel token source
- Type:
- Object
(async) getMapping(config) → {Object}
Returns a single mapping.
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
JSKOS mapping object
- Type:
- Object
(async) getMappings() → {Array.<Object>}
Returns a list of local mappings.
TODO: Add support for sort (created or modified) and order (asc or desc). TODO: Clean up and use async/await
array of JSKOS mapping objects
- Type:
- Array.<Object>
(async) init() → {Promise}
Load data about registry via the status endpoint.
- Inherited From
Promise that resolves when initialization is complete.
- Type:
- Promise
isAuthorizedFor(options) → {boolean}
Returns whether a user is authorized for a certain request.
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object | Properties
|
- Overrides
- Type:
- boolean
(async) patchMapping(config, mapping) → {Object}
Patches a mapping.
| Name | Type | Description |
|---|---|---|
config | Object | |
mapping | Object | JSKOS mapping (or part of mapping) |
JSKOS mapping object
- Type:
- Object
(async) postMapping(config) → {Object}
Creates a mapping.
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
JSKOS mapping object
- Type:
- Object
(async) postMappings(config) → {Array.<Object>}
POSTs multiple mappings. Do not override in subclass!
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
- Inherited From
array of created mapping objects; in case of failure, consult the _errors property on the array at the index of the failed request
- Type:
- Array.<Object>
(async) putMapping(config) → {Object}
Overwrites a mapping.
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
JSKOS mapping object
- Type:
- Object
setAuth(options)
Sets authentication credentials.
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object | Properties
|
- Inherited From
setRetryConfig(config)
Sets retry configuration.
| Name | Type | Description | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config | Object | Properties
|
- Inherited From
supportsScheme(scheme) → {boolean}
Returns a boolean whether a certain target scheme is supported or not.
| Name | Type | Description |
|---|---|---|
scheme | Object |
- Inherited From
- Type:
- boolean