Merge pull request #28 from jayphelps/en

Add enumerable decorator, correct nonenumerable docs/test. Fixes #27

README.md

@@ -16,14 +16,15 @@ This can be consumed by any transpiler that supports decorators like [babel.js](
 
 ## Decorators
 
-##### For Methods
+##### For Properties and Methods
 * [@autobind](#autobind)
 * [@readonly](#readonly)
 * [@override](#override)
 * [@deprecate](#deprecate-alias-deprecated)
 * [@debounce](#debounce)
 * [@throttle](#throttle) :new:
 * [@suppressWarnings](#suppresswarnings)
+* [@enumerable](#enumerable) :new:
 * [@nonenumerable](#nonenumerable)
 * [@nonconfigurable](#nonconfigurable)
 * [@decorate](#decorate) :new:
@@ -211,9 +212,31 @@ person.facepalmWithoutWarning();
 // no warning is logged
 ```
 
+### @enumerable
+
+Marks a method as being enumerable. Note that instance properties are _already_ enumerable, so this is only useful for methods.
+
+```js
+import { enumerable } from 'core-decorators';
+
+class Meal {
+  pay() {}
+
+  @enumerable
+  eat() {}
+}
+
+var dinner = new Meal();
+for (var key in dinner) {
+  key;
+  // "eat" only, not "pay"
+}
+
+```
+
 ### @nonenumerable
 
-Marks a property or method as not being enumerable.
+Marks a property as not being enumerable. Note that class methods are _already_ nonenumerable, so this is only useful for instance properties.
 
 ```js
 import { nonenumerable } from 'core-decorators';

src/core-decorators.js

@@ -4,6 +4,7 @@ export { default as suppressWarnings } from './suppress-warnings';
 export { default as memoize } from './memoize';
 export { default as autobind } from './autobind';
 export { default as readonly } from './readonly';
+export { default as enumerable } from './enumerable';
 export { default as nonenumerable } from './nonenumerable';
 export { default as nonconfigurable } from './nonconfigurable';
 export { default as debounce } from './debounce';

src/enumerable.js

@@ -0,0 +1,10 @@
+import { decorate } from './private/utils';
+
+function handleDescriptor(target, key, descriptor) {
+  descriptor.enumerable = true;
+  return descriptor;
+}
+
+export default function enumerable(...args) {
+  return decorate(handleDescriptor, args);
+}

src/nonenumerable.js

@@ -5,6 +5,6 @@ function handleDescriptor(target, key, descriptor) {
   return descriptor;
 }
 
-export default function enumerable(...args) {
+export default function nonenumerable(...args) {
   return decorate(handleDescriptor, args);
 }

test/unit/enumerable.spec.js

@@ -0,0 +1,14 @@
+import chai from 'chai';
+import enumerable from '../../lib/enumerable';
+
+describe('@enumerable', function () {
+  class Foo {
+    @enumerable
+    bar(){}
+  }
+
+  it('is enumerable', function () {
+    Object.getOwnPropertyDescriptor(Foo.prototype, 'bar')
+      .enumerable.should.equal(true);
+  });
+});

test/unit/nonenumerable.spec.js

@@ -1,19 +1,13 @@
 import chai from 'chai';
 import nonenumerable from '../../lib/nonenumerable';
 
-function enumerable (target, key, descriptor){
-  descriptor.enumerable = true;
-  return descriptor;
-}
-
 describe('@nonenumerable', function () {
   class Foo {
     @nonenumerable
-    @enumerable
-    bar(){}
+    bar = 'test';
   }
 
-  it('is nonenumerable', function () {
+  it('is not enumerable', function () {
     Object.getOwnPropertyDescriptor(Foo.prototype, 'bar')
       .enumerable.should.equal(false);
   });