frint-model

model

Model package for Frint

• Guide
  • Terminologies
  • Usage
• API
  • Model
  • createModel

---

Guide

Installation

With npm:

$ npm install --save frint-model

Via unpkg CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.4/lodash.min.js"></script>

<script src="https://unpkg.com/frint-model@latest/dist/frint-model.min.js"></script>

<script>
  // available as `window.FrintModel`
</script>

Terminologies

• Model: An object class that holds data, e.g. configuration, customer information, etc.

Usage

Let's import the necessary function from the library first:

import { createModel } from 'frint-model';

Now we can create our Model:

const Shirt = createModel({
  getColor: function () {
    return this.get('color');
  },
  getSize: function () {
    return this.get('size');
  },
});

Building a new model instance object:

const shirt = new Shirt({
  color: 'blue',
  size: 'medium',
});

const color = shirt.getColor(); // blue
const size = shirt.getSize();   // medium

---

API

Model

Model

The base Model class. You can extend the base Model class freely to your own like.

Example

import { Model } from 'frint-model';

export default class Shirt extends Model {
  getColor() {
    return this.get('color');
  }

  getSize() {
    return this.get('size');
  }
}

createModel

createModel(extend)

Creates and returns an ES6 compatible class. Useful in non-ES6 compatible environments.

Arguments

1. extend (Object): An object with the functions to extend the base Model class with.

Returns

Function: ES6 compatible class.

Example

const Shirt = createModel({
  getColor: function () {
    return this.get('color');
  },
  getSize: function () {
    return this.get('size');
  },
});

Changelog

v1.0.1 (2017-03-21)

Pull Requests

• frint-compat
  • #147 frint-compat: register models before services and factories.. (@fahad19)
• Other
  • #137 Fix typo in guides sidebar. (@alexmiranda)
• frint-model, frint
  • #136 Add install section to frint-model docs. (@alexmiranda)
• frint-model
  • #135 Fix TOC. (@alexmiranda)
  • #134 Fix for bad merge with frint-model's README, introduced in #101. (@fahad19)

Committers: 2

• Alex Miranda (alexmiranda)
• Fahad Ibnay Heylaal (fahad19)