OpenVeo Core server

API Docs for: 7.0.0
Show:

entityLoader

Defined in: app/server/loaders/entityLoader.js:7
Module: core-loaders

static

Summary

Provides functions to interpret entities definition from plugin's configuration.

Item Index

Methods

Methods

buildEntities

Defined in app/server/loaders/entityLoader.js:14

Syntax

buildEntities

(
  • plugins
)
Object static

Summary

Builds entities for plugins.

Parameters:

  • plugins Array

    The list of plugins

Returns:

Object:

The list of entities, for plugins, ordered by plugin name

Example:

// Results
{
  core: {
    mountPath: '/',
    path: '/home/openveo/',
    entities: {
      applications: 'app/server/controllers/ApplicationController'
    }
  },
  publish: {
    mountPath: '/publish',
    path: '/home/openveo/node_modules/@openveo/publish',
    entities: {
      videos: 'app/server/controllers/VideoController'
    }
  }
}

buildEntitiesRoutes

Defined in app/server/loaders/entityLoader.js:61

Syntax

buildEntitiesRoutes

(
  • entities
)
Object static

Summary

Builds CRUD routes for entities.

Parameters:

  • entities Object

    The list of entities

Returns:

Object:

The list of routes for all entities

Example:

// List of entities as described in configuration file
{
  'applications': '/home/openveo/app/server/controllers/ApplicationController'
}
// Results
{
  'get /applications/:id': '/home/openveo/app/server/controllers/ApplicationController.getEntityAction',
  'get /applications': '/home/openveo/app/server/controllers/ApplicationController.getEntitiesAction',
  'post /applications/:id': '/home/openveo/app/server/controllers/ApplicationController.updateEntityAction',
  'put /applications': '/home/openveo/app/server/controllers/ApplicationController.addEntitiesAction',
  'delete /applications/:id': '/home/openveo/app/server/controllers/ApplicationController.removeEntitiesAction'
}