https://github.com/servable-community/servable-pageable

The pageable protocol handles the complete lifecycle for pageable objects, from storing the models to saving the custom implementation on instianted objects.
https://github.com/servable-community/servable-pageable

nodejs pageable parse-server protocols servable

Last synced: 16 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/servable-community/servable-pageable
• Owner: servable-community
• License: mit
• Created: 2023-09-28T13:57:28.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-29T05:31:33.000Z (over 1 year ago)
• Last Synced: 2024-10-22T21:36:36.606Z (2 months ago)
• Topics: nodejs, pageable, parse-server, protocols, servable
• Language: JavaScript
• Homepage:
• Size: 247 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pageable Protocol

![logo](/static/img/polar-bear-4.png)

[![npm Package](https://img.shields.io/npm/v/servable-pageable.svg?style=flat-square)](https://www.npmjs.org/package/servable-pageable)

[![NPM Downloads](https://img.shields.io/npm/dm/servable-pageable.svg)](https://npmjs.org/package/servable-pageable)

[![Build Status](https://github.com/yelounak/servable-pageable/actions/workflows/release.yml/badge.svg)](https://github.com/yelounak/servable-pageable/actions/tests.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

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

### Shared library

[servable-pageable-shared](https://github.com/yelounak/servable-pageable-shared)

```bash

yarn add servable-pageable-shared

```

### React library

[servable-pageable-react](https://github.com/yelounak/servable-pageable-react)

```bash

yarn add servable-pageable-react

```

## Protocol

### Configuration

#### Payload sample

```json

 {

    "id": "pageable",

    "name": "pageable",

    "slug": "ps",

    "module": {

        "servable-pageable": "*"

    },

    "version": "*",

    "params": {

        "liveClasses": ["pageable"],

        "schema": {

            "restrictSecurity": true

        }

    }

}

```

#### Reference

### Capacities

#### 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

### Security

TODO

### Performance

TODO

## Servable Documentation

You can find here the complete [servable documentation](https://documentation.servable.app/) with guides and api reference.

## License

MIT © [yelounak](https://github.com/yelounak)