loopback-datasource-juggler/lib/kvao/delete.js

51 lines
1.4 KiB
JavaScript

// Copyright IBM Corp. 2017,2019. All Rights Reserved.
// Node module: loopback-datasource-juggler
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT
'use strict';
const assert = require('assert');
const debug = require('debug')('loopback:kvao:delete');
const utils = require('../utils');
/**
* Delete the key-value pair associated to the given key.
*
* @param {String} key Key to use when searching the database.
* @options {Object} options
* @callback {Function} callback
* @param {Error} err Error object.
* @param {*} result Value associated with the given key.
* @promise
*
* @header KVAO.prototype.delete(key[, options], cb)
*/
module.exports = function keyValueDelete(key, options, callback) {
if (callback == undefined && typeof options === 'function') {
callback = options;
options = {};
} else if (!options) {
options = {};
}
assert(typeof key === 'string' && key, 'key must be a non-empty string');
callback = callback || utils.createPromiseCallback();
const connector = this.getConnector();
if (typeof connector.delete === 'function') {
connector.delete(this.modelName, key, options, callback);
} else {
const errMsg = 'Connector does not support key-value pair deletion';
debug(errMsg);
process.nextTick(function() {
const err = new Error(errMsg);
err.statusCode = 501;
callback(err);
});
}
return callback.promise;
};