Space instances.
Type Definitions
Space #
Properties:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
sys |
Object | System metadata
Properties
|
|||||||||
name |
string | Space name | |||||||||
locales |
Array.<string> | Array with locale codes | |||||||||
toPlainObject() |
function | Returns this Space as a plain JS object |
- Source:
SpaceCollection #
Properties:
| Name | Type | Description |
|---|---|---|
total |
number | |
skip |
number | |
limit |
number | |
items |
Array.<Space.Space> | |
toPlainObject() |
function | Returns this Space collection as a plain JS object |
- Source:
Methods
(static) delete() → {Promise} #
Deletes the space
Returns:
Promise for the deletion. It contains no data, but the Promise error case should be handled.
- Type:
- Promise
- Source:
Example
space.delete()
.catch(err => console.log(err))(static) update() → {Promise.<Space.Space>} #
Updates the space
Returns:
Promise for the updated space.
- Type:
- Promise.<Space.Space>
- Source:
Example
space.name = 'Updated Space Name'
space.update()
.then(space => console.log(space))