apeman-service-entity v3.0.0

apeman-service-entity

Apemna service for entity

Installation

$ npm install apeman-service-entity --save

Usage

#!/usr/bin/env node

'use strict'

const { ApEntityService } = require('apeman-service-entity')
const { createStore } = require('redux')
const { reducer } = require('apeman-service-base')
const co = require('co')

co(function * () {
  let store = createStore(reducer)
  let service = new ApEntityService(store)


}).catch((err) => console.error(err))

API

apeman-service-entity@2.2.1

Apemna service for entity

• Functions
  • create(args)
• ApEntityService Class
  • new ApEntityService(store, options)
  • service.getEntityList(entityName)
  • service.getEntityOne(entityName)
  • service.getEntityResources(entityName)
  • service.updateEntityResources(entityName, entities)
  • service.setEntityList(entityName, entities, counts)
  • service.pushEntityList(entityName, entities, counts)
  • service.unshiftEntityList(entityName, entities, counts)
  • service.setEntityOne(entityName, entity)
  • service.clearEntityList(entityName)
  • service.clearEntityOne(entityName)
  • service.clearEntityResource(entityName)
  • service.purgeEntity(entityName)
  • service.invalidateEntityCache(entityName)

Functions

create(args) -> ApEntityService

Create the service instance

ApEntityService Class

Service

new ApEntityService(store, options)

Constructor of ApEntityService class

service.getEntityList(entityName) -> Object

Get entity as list

service.getEntityOne(entityName) -> *

Get detailed entity

service.getEntityResources(entityName) -> Object

Get entity resources.

service.updateEntityResources(entityName, entities) -> Promise

Update entity resources.

service.setEntityList(entityName, entities, counts) -> Promise

Set entity list.

service.pushEntityList(entityName, entities, counts) -> Promise

Push to entity list.

service.unshiftEntityList(entityName, entities, counts) -> Promise

Unshift to entity list.

service.setEntityOne(entityName, entity) -> Promise

Set entity one

service.clearEntityList(entityName) -> Promise

Clear entity list

service.clearEntityOne(entityName) -> Promise

Clear entity one

service.clearEntityResource(entityName) -> Promise

Clear entity resource

service.purgeEntity(entityName) -> Promise

Clear entity one

service.invalidateEntityCache(entityName) -> Promise

Invalidate entity cache

License

This software is released under the MIT License.

Links

• apeman