[FIX] Added a new API

Author: tusharf5

README.md

@@ -29,16 +29,19 @@ Then require it in your module ...
 
 
 ```javascript
-var getClassNames = require('dynamic-class-list').getClassNames;
+var getClassNames = require('dynamic-class-list').getClassNames; // deprecated
+var classList = require('dynamic-class-list').classList;
 ```
 
 ## OR using ES6 imports
 
 
 ```javascript
-import { getClassNames } from 'dynamic-class-list';
+import { getClassNames, classList } from 'dynamic-class-list';
 ```
 
+Note that `getClassNames` is deprecated and will be removed in next major release. You should use `classList` moving forward.
+
 ## API
 
 ### Arguments as strings
@@ -47,6 +50,8 @@ import { getClassNames } from 'dynamic-class-list';
 
 // As Arguments
 getClassNames('class1', 'class2');
+// OR
+classList('class1', 'class2');
 
 // Output : "class1 class2"
 ```
@@ -57,11 +62,11 @@ getClassNames('class1', 'class2');
 ```javascript
 
 // As an Array
-getClassNames(['class1', 'class2']);
+classList(['class1', 'class2']);
 
 // Output : "class1 class2"
 
-getClassNames([null, undefined, 3, 'class1', 'class2']);
+classList([null, undefined, 3, 'class1', 'class2']);
 
 // Output : "3 class1 class2"
 ```
@@ -73,11 +78,11 @@ getClassNames([null, undefined, 3, 'class1', 'class2']);
 ```javascript
 
 // As an Object
-getClassNames({class1: true, class2 : false});
+classList({class1: true, class2 : false});
 
 // Output : "class1"
 
-getClassNames({class1: undefined, class2 : null, class3: true, class4: false});
+classList({class1: undefined, class2 : null, class3: true, class4: false});
 
 // Output : "class3"
 ```
@@ -87,7 +92,7 @@ getClassNames({class1: undefined, class2 : null, class3: true, class4: false});
 ```javascript
 
 // Value as a function As an Object
-getClassNames({ 
+classList({ 
  class1: function() { return false; },
  class2 : function() { return true; }
 });
@@ -100,7 +105,7 @@ getClassNames({
 ```javascript
 
 // using all type of data
-getClassNames('class1', 'class2', 2, null, undefined, ['class3', null, undefined, 4, 'class4'], { 
+classList('class1', 'class2', 2, null, undefined, ['class3', null, undefined, 4, 'class4'], { 
  class5 : function() { return false; },
  class6 : function() { return true; },
  class7: undefined,

index.js

@@ -1,5 +1,6 @@
-var getClassNames = require('./lib/get-class-names').getClassNames;
+const { getClassNames } = require('./lib/get-class-names');
 
 module.exports = {
- getClassNames: getClassNames
+ getClassNames,
+ classList: getClassNames,
 };

lib/get-class-names.js

@@ -1,5 +1,6 @@
 module.exports = {
  getClassNames,
+ classList: getClassNames,
 };
 
 function handleObject(objArg, classList) {

src/get-class-names.js

@@ -1,33 +1,33 @@
 /* eslint-disable no-undef */
-const getClassnames = require('../index').getClassNames;
+const { classList } = require('../index');
 
 test('Print Numbers', () => {
- expect(getClassnames(1, 2)).toBe('1 2');
+ expect(classList(1, 2)).toBe('1 2');
 });
 
 test('Print Strings', () => {
- expect(getClassnames('class', 'another')).toBe('class another');
+ expect(classList('class', 'another')).toBe('class another');
 });
 
 test('Print Array', () => {
- expect(getClassnames(['as', 'asdd'])).toBe('as asdd');
+ expect(classList(['as', 'asdd'])).toBe('as asdd');
 });
 
 test('Print Object', () => {
- expect(getClassnames({ abc: true, cde: false })).toBe('abc');
+ expect(classList({ abc: true, cde: false })).toBe('abc');
 });
 
 test('Print Functions', () => {
- expect(getClassnames({ abc: () => false, cde: () => true })).toBe('cde');
+ expect(classList({ abc: () => false, cde: () => true })).toBe('cde');
 });
 
 test('Print Bad Values', () => {
- expect(getClassnames(null, undefined)).toBe('');
+ expect(classList(null, undefined)).toBe('');
 });
 
 test('Print Bad Values in Object', () => {
  expect(
- getClassnames({
+ classList({
  abs: undefined,
  cdb: null,
  abd: 2,
@@ -38,16 +38,16 @@ test('Print Bad Values in Object', () => {
 });
 
 test('Print Bad Values in Functions', () => {
- expect(getClassnames({ abc: () => undefined, cde: () => null, add: () => {} })).toBe('');
+ expect(classList({ abc: () => undefined, cde: () => null, add: () => {} })).toBe('');
 });
 
 test('Print Bad Values in Array', () => {
- expect(getClassnames([null, undefined, 1, 'asd', {}])).toBe('1 asd');
+ expect(classList([null, undefined, 1, 'asd', {}])).toBe('1 asd');
 });
 
 test('Print hybrid', () => {
  expect(
- getClassnames(
+ classList(
  1,
  2,
  'class',