github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-22 13:28:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

📝 Mention previous value is in second argument object

Browse Source
This commit is contained in:
Kevin Sawicki
2014-05-15 10:15:57 -07:00
parent 42c4dc6937
commit 7d655bf840
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/config.coffee
View File

@@ -222,9 +222,10 @@ class Config
#
# keyPath - The {String} name of the key to observe
# options - An optional {Object} containing the `callNow` key.
# callback - The {Function} that fires when the value of the key is
# changed. It is given a single argument, `value`, which is
# the new value of `keyPath`.
# callback - The {Function} to call when the value of the key changes.
# The first argument will be the new value of the key and the
#   second argument will be an {Object} with a `previous` property
# that is the prior value of the key.
#
# Returns an {Object} with the following keys:
# :off - A {Function} that unobserves the `keyPath` when called.