driver-interface/layers/cache/flush-cache.js

Standardized interface for common functionality, expressed in layers. Covers communication with databases, hardware, web services, and more.

module.exports = {


  friendlyName: 'Flush cache',


  description: 'Flush the cache, removing all data from it.',


  sideEffects: 'idempotent',


  inputs: {

    connection: {
      friendlyName: 'Connection',
      description: 'An active connection.',
      extendedDescription: 'The provided connection instance must still be active.  Only connection instances created by the `getConnection()` machine in the same driver are supported.',
      example: '===',
      required: true
    },

    meta: {
      friendlyName: 'Meta (custom)',
      description: 'Additional metadata to pass to the driver.',
      extendedDescription: 'This input is not currently in use, but is reserved for driver-specific customizations in the future.',
      example: '==='
    }

  },


  exits: {

    success: {
      description: 'Cache was successfully flushed.',
      outputVariableName: 'report',
      outputDescription: 'The return value is true when the cache was successfully flushed.',
      outputExample: true
    },

    failed: {
      description: 'The cache encountered an error while attempting to flush the cache.',
      outputVariableName: 'report',
      outputDescription: 'The `error` property is a JavaScript Error instance explaining the exact error.  The `meta` property is reserved for custom driver-specific extensions.',
      outputExample: {
        error: '===',
        meta: '==='
      }
    },

    badConnection: require('../../constants/badConnection.exit')

  }


};