Skip to content

Commit a113699

Browse files
committed
docs: document Object#unset param
1 parent f44017d commit a113699

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/object.js

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -778,6 +778,7 @@ module.exports = function(AV) {
778778
* Remove an attribute from the model, firing <code>"change"</code> unless
779779
* you choose to silence it. This is a noop if the attribute doesn't
780780
* exist.
781+
* @param key {String} The key.
781782
*/
782783
unset: function(attr, options) {
783784
options = options || {};
@@ -789,7 +790,7 @@ module.exports = function(AV) {
789790
* Atomically increments the value of the given attribute the next time the
790791
* object is saved. If no amount is specified, 1 is used by default.
791792
*
792-
* @param attr {String} The key.
793+
* @param key {String} The key.
793794
* @param amount {Number} The amount to increment by.
794795
*/
795796
increment: function(attr, amount) {
@@ -802,7 +803,7 @@ module.exports = function(AV) {
802803
/**
803804
* Atomically add an object to the end of the array associated with a given
804805
* key.
805-
* @param attr {String} The key.
806+
* @param key {String} The key.
806807
* @param item {} The item to add.
807808
*/
808809
add: function(attr, item) {
@@ -814,7 +815,7 @@ module.exports = function(AV) {
814815
* if it is not already present in the array. The position of the insert is
815816
* not guaranteed.
816817
*
817-
* @param attr {String} The key.
818+
* @param key {String} The key.
818819
* @param item {} The object to add.
819820
*/
820821
addUnique: function(attr, item) {
@@ -825,7 +826,7 @@ module.exports = function(AV) {
825826
* Atomically remove all instances of an object from the array associated
826827
* with a given key.
827828
*
828-
* @param attr {String} The key.
829+
* @param key {String} The key.
829830
* @param item {} The object to remove.
830831
*/
831832
remove: function(attr, item) {
@@ -836,7 +837,7 @@ module.exports = function(AV) {
836837
* Atomically apply a "bit and" operation on the value associated with a
837838
* given key.
838839
*
839-
* @param attr {String} The key.
840+
* @param key {String} The key.
840841
* @param value {Number} The value to apply.
841842
*/
842843
bitAnd(attr, value) {
@@ -847,7 +848,7 @@ module.exports = function(AV) {
847848
* Atomically apply a "bit or" operation on the value associated with a
848849
* given key.
849850
*
850-
* @param attr {String} The key.
851+
* @param key {String} The key.
851852
* @param value {Number} The value to apply.
852853
*/
853854
bitOr(attr, value) {
@@ -858,7 +859,7 @@ module.exports = function(AV) {
858859
* Atomically apply a "bit xor" operation on the value associated with a
859860
* given key.
860861
*
861-
* @param attr {String} The key.
862+
* @param key {String} The key.
862863
* @param value {Number} The value to apply.
863864
*/
864865
bitXor(attr, value) {
@@ -871,7 +872,7 @@ module.exports = function(AV) {
871872
* saved. For example, after calling object.increment("x"), calling
872873
* object.op("x") would return an instance of AV.Op.Increment.
873874
*
874-
* @param attr {String} The key.
875+
* @param key {String} The key.
875876
* @returns {AV.Op} The operation, or undefined if none.
876877
*/
877878
op: function(attr) {

0 commit comments

Comments
 (0)