Add docs for stub.value

sinonjs · May 21, 2017 · 0ea3e17 · 0ea3e17
1 parent c89fb21
commit 0ea3e17
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs/release-source/release/stubs.md b/docs/release-source/release/stubs.md
@@ -520,3 +520,31 @@ myObj.prop = 'baz';
 
 myObj.example; // 'baz'
 ```
+
+#### `stub.value(newVal)`
+
+Defines a new value for this stub.
+
+```javascript
+var myObj = {
+    example: 'oldValue',
+};
+
+sinon.stub(myObj, 'example').value('newValue');
+
+myObj.example; // 'newValue'
+```
+
+You can restore values by calling the `restore` method:
+
+```javascript
+var myObj = {
+    example: 'oldValue',
+};
+
+var stub = sinon.stub(myObj, 'example').value('newValue');
+stub.restore()
+
+myObj.example; // 'oldValue'
+```
+