Pageable Protocol

!logo


The pageable protocol handles the complete lifecycle for pageable objects, from storing the models to saving the custom implementation on instianted objects.

Install

``bash
yarn add servable-pageable
`

Auxiliary packages

$3

servable-pageable-shared
`bash
yarn add servable-pageable-shared
`

$3

servable-pageable-react
`bash
yarn add servable-pageable-react
`

Protocol

$3

#### Payload sample
`json
{
"id": "pageable",
"name": "pageable",
"slug": "ps",
"module": {
"servable-pageable": "*"
},
"version": "*",
"params": {
"liveClasses": ["pageable"],
"schema": {
"restrictSecurity": true
}
}
}
`
#### Reference

$3

#### Schema
Classes
TODO

Class level permissions
TODO

Indexes
`json
{
"_pageableStatus": {
"pageableStatus": 1
}
}
`

Fields
`json
{
"pageableStatus": {
"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

$3

TODO

$3

TODO

Servable Documentation

You can find here the complete servable documentation with guides and api reference.

License

MIT © yelounak