From ecf97b1a98e0ea6ea0743d432bee440186e20f53 Mon Sep 17 00:00:00 2001 From: ngavalas Date: Fri, 14 Jun 2013 16:37:20 -0700 Subject: [PATCH] Updated docs and check for truthiness Change api docs to reflect presence of the new argument. In addition, callback was change to require only a "truthy" value. --- docs/api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index fd29070e..cc73f2e3 100644 --- a/docs/api.md +++ b/docs/api.md @@ -108,15 +108,17 @@ Transfer properties from this component to a target component that have not alre #### setState ```javascript -setState(object nextState) +setState(object nextState_[, function callback]_) ``` -Merges nextState with the current state. This is the primary method you use to trigger UI updates from event handlers and server request callbacks. +Merges nextState with the current state. This is the primary method you use to trigger UI updates from event handlers and server request callbacks. In addition, you can supply an optional callback function that is executed once `setState` is completed. **Note:** *NEVER* mutate `this.state` directly. As calling `setState()` afterwards may replace the mutation you made. Treat `this.state` as if it were immutable. **Note:** `setState()` does not immediately mutate `this.state` but creates a pending state transition. Accessing `this.state` after calling this method can potentially return the existing value. +**Note**: There is no guarantee of synchronous operation of calls to `setState` and calls may eventually be batched for performance gains. + #### replaceState ```javascript