Merge pull request #1213 from tiemevanveen/docs-restore

Added documentation for sinon.restore()
sinonjs · Dec 27, 2016 · 02bbc83 · 02bbc83
2 parents 64ff97e + 25aea44
commit 02bbc83
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 0 deletions.
diff --git a/docs/_releases/v1.17.6/utils.md b/docs/_releases/v1.17.6/utils.md
@@ -8,6 +8,26 @@ Sinon.JS has a few utilities used internally in `lib/sinon.js`. Unless the metho
 
 ## Utils API
 
+#### `sinon.restore(object);`
+
+Restores all fake methods of supplied object
+
+```javascript
+    sinon.stub(obj);
+
+    // run tests...
+
+    sinon.restore(obj);
+```
+
+#### `sinon.restore(method);`
+
+Restores supplied method
+
+```javascript
+    sinon.restore(obj.someMethod);
+```
+
 #### `sinon.createStubInstance(constructor);`
 
 Creates a new object with the given function as the protoype and stubs all implemented functions.

diff --git a/docs/_releases/v2.0.0-pre.4/utils.md b/docs/_releases/v2.0.0-pre.4/utils.md
@@ -8,6 +8,26 @@ Sinon.JS has a few utilities used internally in `lib/sinon.js`. Unless the metho
 
 ## Utils API
 
+#### `sinon.restore(object);`
+
+Restores all fake methods of supplied object
+
+```javascript
+    sinon.stub(obj);
+
+    // run tests...
+
+    sinon.restore(obj);
+```
+
+#### `sinon.restore(method);`
+
+Restores supplied method
+
+```javascript
+    sinon.restore(obj.someMethod);
+```
+
 #### `sinon.createStubInstance(constructor);`
 
 Creates a new object with the given function as the protoype and stubs all implemented functions.

diff --git a/docs/release-source/release/utils.md b/docs/release-source/release/utils.md
@@ -8,6 +8,26 @@ Sinon.JS has a few utilities used internally in `lib/sinon.js`. Unless the metho
 
 ## Utils API
 
+#### `sinon.restore(object);`
+
+Restores all fake methods of supplied object
+
+```javascript
+    sinon.stub(obj);
+
+    // run tests...
+
+    sinon.restore(obj);
+```
+
+#### `sinon.restore(method);`
+
+Restores supplied method
+
+```javascript
+    sinon.restore(obj.someMethod);
+```
+
 #### `sinon.createStubInstance(constructor);`
 
 Creates a new object with the given function as the protoype and stubs all implemented functions.