Merge pull request #18386 from mukilane/docs/ember-array-firstObject

[DOC] Added example for EmberArray#firstObject
emberjs · Sep 25, 2019 · 5117d1b · 5117d1b
2 parents 122ebec + 6f6fd33
commit 5117d1b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/packages/@ember/-internals/runtime/lib/mixins/array.js b/packages/@ember/-internals/runtime/lib/mixins/array.js
@@ -302,6 +302,20 @@ const ArrayMixin = Mixin.create(Enumerable, {
   /**
     The first object in the array, or `undefined` if the array is empty.
 
+    ```javascript
+    let vowels = ['a', 'e', 'i', 'o', 'u'];
+    vowels.firstObject; // 'a'
+
+    vowels.shiftObject();
+    vowels.firstObject; // 'e'
+
+    vowels.reverseObjects();
+    vowels.firstObject; // 'u'
+    
+    vowels.clear();
+    vowels.firstObject; // undefined
+    ```
+
     @property firstObject
     @return {Object | undefined} The first object in the array
     @public