Merge pull request #548 from wheresrhys/document-version-added

Document version added

docs/_about/previous-versions.md

@@ -2,7 +2,7 @@
 title: Previous versions
 position: 3
 content_markdown: |-
-  v7, v8 & v9 are practically identical, only differing in their treatment of a few edge cases, or in compatibility with other libraries and environments.
+  v7, v8 & v9 are practically identical, only differing in their treatment of a few edge cases, or in compatibility with other libraries and environments. For clarity, each section of the documentation tells you which version a feature was added with a <small class="version-added">version</small> label.
 
   For previous versions follow the documentation below: 
 

docs/_api-inspection/called.md

@@ -2,6 +2,7 @@
 title: .called(filter, options)
 navTitle: .called()
 position: 1
+versionAdded: 1.0.0
 description: |-
   Returns a Boolean indicating whether any calls to `fetch` matched the given `filter` and `options`
 ---

docs/_api-inspection/calls.md

@@ -2,6 +2,7 @@
 title: .calls(filter, options)
 navTitle: .calls()
 position: 2
+versionAdded: 1.0.0
 description: |-
   Returns an array of all calls to fetch matching the given `filter` and `options`. Each call is returned as a `[url, options]` array. If `fetch` was called using a `Request` instance, the `url` and `options` will be inferred from it, and the original `Request` will be available as a `request` property on this array.
 ---

docs/_api-inspection/done.md

@@ -2,6 +2,7 @@
 title: .done(filter)
 navTitle: .done()
 position: 6
+versionAdded: 5.3.0
 description: |-
   Returns a Boolean indicating whether `fetch` was called the expected number of times (or has been called at least once if `repeat` is undefined for the route). It does not take into account whether the `fetches` completed successfully.
 parameters:

docs/_api-inspection/fundamentals.md

@@ -13,11 +13,12 @@ parameters:
     options:
       - types:
           - undefined
+        versionAdded: 6.0.0
         content: |-
           Retrieve all calls made to `fetch`
       - types:
           - true
-          - '"matched"'
+        versionAdded: 6.0.0
         content: |-
           Retrieve all calls to `fetch` matched by some route defined by `fetch-mock`. The string `'matched'` can be used instead of `true` to make tests more readable
         examples:
@@ -27,33 +28,41 @@ parameters:
             fetchMock.calls(MATCHED)
       - types:
           - false
-          - '"unmatched"'
+        versionAdded: 6.0.0
         content: |-
           Retrieve all calls to `fetch` not matched by some route defined by `fetch-mock`. The string `'unmatched'` can be used instead of `false` to make tests more readable
         examples:
           - |-
             const {UNMATCHED, fetchMock} = require('fetch-mock');
             ...
             fetchMock.calls(UNMATCHED)
+      - types:
+          - '"matched"'
+          - '"unmatched"'
+        versionAdded: 9.0.0
+        content: Aliases for `true` and `false`
       - name: routeIdentifier
         types:
           - String
           - RegExp
           - function
+        versionAdded: 2.0.0
         content: |-
           All routes have an identifier:
           - If it's a [named route](#api-mockingmock_options), the identifier is the route's `name`
           - If the route is unnamed, the identifier is the value of the `matcher` argument that was passed in to `.mock()`
 
           All calls that were handled by the route with the given identifier will be retrieved
       - name: matcher
+        versionAdded: 7.0.0
         types:
           - String
           - RegExp
           - function
         content: |-
           Any matcher compatible with the [mocking api](#api-mockingmock_matcher) can be passed in to filter the calls arbitrarily. The matcher will be executed using exactly the same rules as the mocking api
   - name: options
+    versionAdded: 7.0.0
     types:
       - Object
       - String

docs/_api-inspection/lastCall.md

@@ -2,6 +2,7 @@
 title: .lastCall(filter, options)
 navTitle: .lastCall()
 position: 3
+versionAdded: 4.0.0
 description: |-
   Returns the arguments for the last call to `fetch` matching the given `filter` and `options`. The call is returned as a `[url, options]` array. If `fetch` was called using a `Request` instance, the `url` and `options` will be inferred from it, and the original `Request` will be available as a `request` property on this array.
 ---

docs/_api-inspection/lastOptions.md

@@ -2,6 +2,7 @@
 title: .lastOptions(filter, options)
 navTitle: .lastOptions()
 position: 5
+versionAdded: 4.0.0
 description: |-
   Returns the options for the call to `fetch` matching the given `filter` and `options`. If `fetch` was last called using a `Request` instance, a set of `options` inferred from the `Request` will be returned
 ---

docs/_api-inspection/lastUrl.md

@@ -2,6 +2,7 @@
 title: .lastUrl(filter, options)
 navTitle: .lastUrl()
 position: 4
+versionAdded: 4.0.0
 description: |-
   Returns the url for the last call to `fetch` matching the given `filter` and `options`. If `fetch` was last called using a `Request` instance, the url will be inferred from this
 ---

docs/_api-lifecycle/flush.md

@@ -2,6 +2,7 @@
 title: .flush(waitForBody)
 navTitle: '.flush()'
 position: 2
+versionAdded: 5.11.0
 description: |-
   Returns a `Promise` that resolves once all fetches handled by fetch-mock have resolved
 content_markdown: |-

docs/_api-lifecycle/resetBehavior.md

@@ -1,6 +1,7 @@
 ---
 title: .resetBehavior()
 position: 5
+versionAdded: 7.0.0
 description: |-
   Removes all mock routes from the instance of `fetch-mock`, and restores `fetch` to its original implementation if movcking globally. Will not clear data recorded for `fetch`'s calls.
 content_markdown: |-

docs/_api-lifecycle/resetHistory.md

@@ -1,6 +1,7 @@
 ---
 title: .resetHistory()
 position: 4
+versionAdded: 7.0.0
 description: |-
   Clears all data recorded for `fetch`'s calls. It _will not_ restore fetch to its default implementation
 content_markdown: |-

docs/_api-lifecycle/restore_reset.md

@@ -2,6 +2,7 @@
 title: .restore(), .reset()
 navTitle: .restore(), .reset()
 position: 3
+versionAdded: 7.0.0
 description: |-
   Resets `fetch()` to its unstubbed state and clears all data recorded for its calls. `restore()` is an alias for `reset()`
 content_markdown: |-

docs/_api-lifecycle/sandbox.md

@@ -1,6 +1,7 @@
 ---
 title: '.sandbox()'
 position: 1.0
+versionAdded: 5.6.0
 description: |-
   Returns a function that can be used as a drop-in replacement for `fetch`. Pass this into your mocking library of choice. The function returned by `sandbox()` has all the methods of `fetch-mock` exposed on it and maintains its own state independent of other instances, so tests can be run in parallel.
 left_code_blocks:

docs/_api-mocking/add-matcher.md

@@ -2,6 +2,7 @@
 title: ".addMatcher({name, usesBody, matcher})"
 navTitle: .addMatcher()
 position: 1.9
+versionAdded: 9.3.0
 description: |-
   Allows adding your own, reusable custom matchers to fetch-mock, for example a matcher for interacting with GraphQL queries, or an `isAuthorized` matcher that encapsulates the exact authorization conditions for the API you are mocking, and only requires a `true` or `false` to be input
 parentMethodGroup: mocking

docs/_api-mocking/catch.md

@@ -2,6 +2,7 @@
 title: '.catch(response)'
 navTitle: .catch()
 position: 8
+versionAdded: 5.0.0
 description: |-
   Specifies how to respond to calls to `fetch` that don't match any mocks.
 parentMethodGroup: mocking

docs/_api-mocking/getAnyOnce_postAnyOnce.md

@@ -2,6 +2,7 @@
 title: '.getAnyOnce(), .postAnyOnce(), .putAnyOnce(), .deleteAnyOnce(), .headAnyOnce(), .patchAnyOnce()'
 navTitle: .getAnyOnce(), .postAnyOnce() ...
 position: 7
+versionAdded: 9.2.0
 description: |-
   Shorthands for `anyOnce()` that only respond to requests using a particular http method.
 parentMethodGroup: mocking

docs/_api-mocking/getAny_postAny.md

@@ -2,6 +2,7 @@
 title: '.getAny(), .postAny(), .putAny(), .deleteAny(), .headAny(), .patchAny()'
 navTitle: .getAny(), .postAny() ...
 position: 5.5
+versionAdded: 9.2.0
 description: |-
   Shorthands for `any()` that only respond to requests using a particular http method.
 parentMethodGroup: mocking

docs/_api-mocking/getOnce_postOnce.md

@@ -2,6 +2,7 @@
 title: '.getOnce(), .postOnce(), .putOnce(), .deleteOnce(), .headOnce(), .patchOnce()'
 navTitle: .getOnce(), .postOnce() ...
 position: 4
+versionAdded: 5.3.0
 description: |-
   Shorthands for `mock()` that create routes that only respond to requests using a particular http method, and that can only mock a single request.
 parentMethodGroup: mocking

docs/_api-mocking/get_post.md

@@ -2,6 +2,7 @@
 title: '.get(), .post(), .put(), .delete(), .head(), .patch()'
 navTitle: .get(), .post() ...
 position: 2
+versionAdded: 5.0.0
 description: |-
   Shorthands for `mock()` that create routes that only respond to requests using a particular http method.
 parentMethodGroup: mocking

docs/_api-mocking/mock.md

@@ -2,6 +2,8 @@
 title: '.mock(matcher, response, options)'
 navTitle: .mock()
 position: 1
+versionAdded: 2.0.0
+versionAddedDetails: Callable with no arguments since v7.6.0
 description: |
   Check out the new [cheatsheet](https://github.com/wheresrhys/fetch-mock/blob/master/docs/cheatsheet.md)
   {: .info}
@@ -12,13 +14,15 @@ description: |
   {: .warning}
 parameters:
   - name: matcher
+    versionAdded: 2.0.0
     types:
       - String
       - Regex
       - Function
       - Object
     content: Criteria for which calls to `fetch` should match this route
   - name: response
+    versionAdded: 2.0.0
     types:
       - String
       - Object
@@ -27,6 +31,7 @@ parameters:
       - Response
     content: Response to send when a call is matched
   - name: options
+    versionAdded: 2.0.0
     types:
       - Object
     content: More options to configure matching and responding behaviour

docs/_api-mocking/mock_any.md

@@ -2,6 +2,7 @@
 title: '.any(response, options)'
 navTitle: .any()
 position: 5
+versionAdded: 9.2.0
 description: |-
   Shorthand for `mock()` which creates a route that will return a response to any fetch request.
 parentMethodGroup: mocking

docs/_api-mocking/mock_any_once.md

@@ -2,6 +2,7 @@
 title: '.anyOnce(response, options)'
 navTitle: .anyOnce()
 position: 6
+versionAdded: 9.2.0
 description: |-
   Shorthand for `mock()` which creates a route that will return a response to any single fetch request.
 parentMethodGroup: mocking