Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcosrava/model-prefect
https://github.com/marcosrava/model-prefect
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/marcosrava/model-prefect
- Owner: MarcosRava
- Created: 2016-08-21T23:09:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-08-24T20:03:40.000Z (over 8 years ago)
- Last Synced: 2024-11-09T16:47:23.793Z (2 months ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
## A simple model presenter
WIP
## Proposal
### Instalation
```
npm install model-prefect
```
### Simple usage
```js
let ford = {
fullName: "Ford Prefect",
nickname: "Ix",
species: "Betelgeusian"
};
const opts = {
"map": {
"fullName": "name"
},
"exclude" : ["nickname"]
};
let fordPresenter = new ModelPrefect(ford, opts);
// {"name": "Ford Prefect", "species": "Betelgeusian"}
```
### Usage with [Betelgeuse](https://github.com/MarcosRava/betelgeuse)
```js
import Betelgeuse, { Types } from 'betelgeuse';
import ModelPrefect from 'model-prefect';
ModelPrefect.goesToBetelgeuse(Betelgeuse); // Add `toPresenter` function to Betelgeuse instances
class Ford extends Betelgeuse {
static schema = {
fullName: {
type: Types.string,
minLength: 3
},
nickname: {
type: Types.string,
minLength: 3
},
species: Types.string
}
static presenter = {
"map": {
"fullName": "name"
}
"exclude": ["nickname"]
}
}
let ford = new Ford({
fullName: "Ford Prefect",
nickname: "Ix",
species: "Betelgeusian"
});
ford.toPresenter();
// {"name": "Ford Prefect", "species": "Betelgeusian"}
```
Or
```js
class FordPresenter extends ModelPrefect {
static presenter = {
"map": {
"fullName": "name"
}
"exclude": ["nickname"]
}
}
let fordPresenter = new FordPresenter(ford);
// {"name": "Ford Prefect", "species": "Betelgeusian"}
```
Schema
```js
class FordPresenter extends ModelPrefect {
static options = {
"betelgeuse" : true, // convert validation schema
"presenter": {
"fullName": "name"
}
"exclude": ["nickname"]
}
}
let fordPresenter = new FordPresenter(ford);
/*
{
"name": "Ford Prefect",
"species": "Betelgeusian",
"_schema": {
"name": {
"type": "string",
"minLength": 3
},
"species": {
"type": "string"
}
}
}
*/
fordPresenter.isValid
// Function.isValid
fordPresenter.fields()
// {"name": "Ford Prefect", "species": "Betelgeusian"}
```