Global

Methods

(static) module:grunt/copyTask(grunt) → {function}

Parameters:

Source:

• grunt/copyTask.js, line 38

Returns:

Type

function

Example

// Register task
var openVeoApi = require('@openveo/api');
grunt.registerMultiTask('copy', openVeoApi.grunt.copyTask(grunt));

// Configure task
grunt.initConfig({
  copy: {
    copyDirectory: {
      src: 'directoryToCopy',
      dest: 'some/directory/'
    },
    copyFile: {
      src: 'fileToCopy.txt',
      dest: 'some/directory/'
    }
  }
});

(static) module:grunt/ngDpTask(grunt) → {function}

Parameters:

Source:

• grunt/ngDpTask.js, line 63

Returns:

Type

function

Example

// Register task
var openVeoApi = require('@openveo/api');
grunt.registerMultiTask('ngDp', openVeoApi.grunt.ngDpTask(grunt));

// Configure task
grunt.initConfig({
  'ngDp': {
    options: {
      basePath: '/path/to/the/',
      cssPrefix: '../../other/css/path/',
      jsPrefix: '../../other/js/path/'
    },
    app1: {
      src: '/path/to/the/app1/**\/*.*',
      dest: '/path/to/the/app1/topology.json'
    },
    app2: {
      src: '/path/to/the/app2**\/*.*',
      dest: '/path/to/the/app2/topology.json'
    }
  }
});

// Ouput example (/path/to/the/app1/topology.json)
{
  js: ['../..other/js/path/app1/file1.js', '../..other/js/path/app1/file2.js', [...]],
  css: ['../..other/css/path/app1/file1.css', '../..other/css/path/app1/file2.css', [...]]
}

AngularJS applications, which respect components architecture, need to be loaded in the right order as some
components may depend on other components. This task helps build an array of JavaScript files and css / scss files
in the right order.

For this to work, each module must be declared in a separated file and a single file should not define AngularJS
elements belonging to several different modules.

Available options are:
  - basePath: The base path which will be replaced by the cssPrefix or jsPrefix
  - cssPrefix: For CSS / SCSS files, replace the basePath by this prefix
  - jsPrefix: For JS files, replace the basePath by this prefix

(static) module:grunt/removeTask(grunt) → {function}

Parameters:

Source:

• grunt/removeTask.js, line 36

Returns:

Type

function

Example

// Register task
var openVeoApi = require('@openveo/api');
grunt.registerMultiTask('remove', openVeoApi.grunt.removeTask(grunt));

// Configure task
grunt.initConfig({
  removeTask: {
    removeDirectory: {
      src: 'directoryToRemove'
    },
    removeFile: {
      src: 'fileToRemove.txt'
    }
  }
});

(static) module:grunt/renameTask(grunt) → {function}

Parameters:

Source:

• grunt/renameTask.js, line 38

Returns:

Type

function

Example

// Register task
var openVeoApi = require('@openveo/api');
grunt.registerMultiTask('rename', openVeoApi.grunt.renameTask(grunt));

// Configure task
grunt.initConfig({
  rename: {
    renameDirectory: {
      src: 'directoryToRename',
      dest: 'some/sub/directories/directoryRenamed'
    },
    renameFile: {
      src: 'fileToRename.txt',
      dest: 'some/sub/directories/fileRenamed.txt'
    }
  }
});

(static) module:middlewares/disableCacheMiddleware(request, response, next)

Parameters:

Source:

• middlewares/disableCacheMiddleware.js, line 26

Example

var openVeoApi = require('@openveo/api');
expressApp.use(openVeoApi.middlewares.disableCacheMiddleware);

(static) module:middlewares/imageProcessorMiddleware(imagesDirectory, cacheDirectory, styles, headers) → {function}

Parameters:

Source:

• middlewares/imageProcessorMiddleware.js, line 49

Throws:

If imagesdirectory or styles is empty

Type

TypeError

Returns:

Type

function

Example

var openVeoApi = require('@openveo/api');
expressApp.use('/mount-path', openVeoApi.middlewares.imageProcessorMiddleware(
  '/path/to/the/folder/containing/images'
  '/path/to/the/folder/containing/processed/images/cache'
  [
    {
      id: 'my-thumb', // Id of the style to apply when requesting an image processing
      width: 200, // Expected width (in px) of the image
      quality: 50 // Expected quality from 0 to 100 (default to 90 with 100 the best)
    }
  ]
));

// Then it's possible to apply style "my-thumb" to the image /mount-path/my-image.jpg using
// parameter "style": /mount-path/my-image.jpg?style=my-thumb

(static) module:middlewares/logRequestMiddleware(request, response, next)

Parameters:

Source:

• middlewares/logRequestMiddleware.js, line 20

Example

var openVeoApi = require('@openveo/api');
expressApp.use(openVeoApi.middlewares.logRequestMiddleware);

Type Definitions

callback(error)

Parameters:

Source:

• jsdocTypes.js, line 1