getSpecifications #
Returns the validation specifications associated to the given index and collection.
getSpecifications(index, collection, [options]);
Arguments | Type | Description |
---|---|---|
index | string | Index name |
collection | string | Collection name |
options | object | Query options |
options #
Additional query options
Property | Type (default) | Description |
---|---|---|
queuable | boolean ( true ) | If true, queues the request during downtime, until connected to Kuzzle again |
timeout | number | Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely |
Resolves #
Resolve to an object representing the collection specifications.
Usage #
try {
const specifications = await kuzzle.collection.getSpecifications(
'nyc-open-data',
'yellow-taxi'
);
console.log(specifications);
/*
{
"collection": "yellow-taxi",
"index": "nyc-open-data",
"validation": {
"fields": {
"age": {
"defaultValue": 42,
"mandatory": true,
"type": "integer"
}
},
"strict": true
}
}
*/
console.log('Success');
} catch (error) {
console.error(error.message);
}
Edit this page on Github(opens new window)