1.0.2 • Published 3 months ago
servable-reviewable v1.0.2
Reviewable Protocol
The reviewable protocol handles the complete publication state of an object.
Install
yarn add servable-reviewable
Auxiliary packages
Shared library
yarn add servable-reviewable-shared
React library
yarn add servable-reviewable-react
Protocol
Configuration
Payload sample
{
"id": "reviewable",
"name": "reviewable",
"slug": "ps",
"module": {
"servable-reviewable": "*"
},
"version": "*",
"params": {
"liveClasses": ["reviewable"],
"schema": {
"restrictSecurity": true
}
}
}
Reference
Capacities
Schema
Classes TODO
Class level permissions TODO
Indexes
{
"_reviewableStatus": {
"reviewableStatus": 1
}
}
Fields
{
"reviewableStatus": {
"type": "String"
}
}
Protocol class
TODO
Classes
TODO
Triggers
TODO
Before init
TODO
After init
TODO
Seed
TODO
Config
TODO
Functions
TODO
Jobs
TODO
Live classes
TODO
Security
TODO
Performance
TODO
Servable Documentation
You can find here the complete servable documentation with guides and api reference.
License
MIT © yelounak