Skip to content

Commit 6fe773c

Browse files
committed
2 parents 6ee3718 + 8dceb09 commit 6fe773c

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/data-components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ The `FeathersVuexFind` component retrieves data from the API server, puts it in
9393
- `query {Object}` <Badge text="deprecated" type="warning"/> **use `params` instead** - the query object. If only the `query` attribute is provided, the same query will be used for both the `find` getter and the `find` action. See the `fetchQuery` attribute for more information. When using server-side pagination, use the `fetchQuery` prop and the `query` prop for querying data from the local store. If the query is `null` or `undefined`, the query against both the API and store will be skipped. The find getter will return an empty array.
9494
- `watch {String|Array}` - specify the attributes of the `params` or `fetchParams` to watch. Pass 'params' to watch the entire params object. Pass 'params.query.name' to watch the 'name' property of the query. Watch is turned off by default, so the API server will only be queried once, by default. **Default: []**
9595
- `fetchQuery {Object}` <Badge text="deprecated" type="warning"/> **use `fetchParams` instead** - when provided, the `fetchQuery` serves as the query for the API server. The `query` param will be used against the service's local Vuex store. **Default: undefined**
96-
- `params {Object}` - the params object. If only the `params` attribute is provided, te same params will be used for both the `find` getter and the `find` action. See the `fetchParams` attribute for more information. <Badge text="3.11.0+" />
97-
- `fetchParams {Object}` - when provided, the `fetchParams` servers as the params for the API server. The `params` will be used against the service's local Vuex store. <Badge text="3.11.0+" />
96+
- `params {Object}` - the params object. If only the `params` attribute is provided, te same params will be used for both the `find` getter and the `find` action. See the `fetchParams` attribute for more information. <Badge text="3.12.0+" />
97+
- `fetchParams {Object}` - when provided, the `fetchParams` servers as the params for the API server. The `params` will be used against the service's local Vuex store. <Badge text="3.12.0+" />
9898
- `queryWhen {Boolean|Function}` - the query to the server will only be made when this evaluates to true. **Default: true**
9999
- `local {Boolean}` - when set to true, will only use the `query` prop to get data from the local Vuex store. It will disable queries to the API server. **Default:false**
100100
- `editScope {Function}` - a utility function that allows you to modify the scope data, and even add attributes to it, before providing it to the default slot. You can also use it to pull data into the current component's data (though that may be less recommended, it can come in handy). See the "Scope Data" section to learn more about what props are available in the scope object. **Default: scope => scope**
@@ -165,7 +165,7 @@ export default {
165165
- `item {Object}` - The resulting record for the get operation.
166166
- `isGetPending {Boolean}` - When there's an active request to the API server, this will be `true`. This is not the same as the `isGetPending` from the Vuex state. The value in the Vuex state is `true` whenever **any** component is querying data from that same service. This `isGetPending` attribute is specific to each component instance.
167167

168-
## FeathersVuexCount <Badge text="3.11.0+" />
168+
## FeathersVuexCount <Badge text="3.12.0+" />
169169

170170
The `FeathersVuexCount` component allows displaying a count of records. It makes the slot scope available to the child components. It adds `$limit: 0` to the passed params in the background. This will only run a (fast) counting query against the database.
171171

docs/model-classes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ created () {
156156
}
157157
```
158158

159-
### count(params) <Badge text="3.11.0+" />
159+
### count(params) <Badge text="3.12.0+" />
160160

161161
Model classes have a `count` method, which is a proxy to the `count` action. On the Feathers server, `$limit: 0` results in a fast count query. (./service-plugin.html#find-params).
162162

@@ -172,7 +172,7 @@ async created () {
172172
}
173173
```
174174

175-
### countInStore(params) <Badge text="3.11.0+" />
175+
### countInStore(params) <Badge text="3.12.0+" />
176176

177177
Model classes have a `countInStore` method, which is a proxy to the [`count` getter](./service-plugin.html#Service-Getters).
178178

docs/service-plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ Service modules include the following getters:
200200
- `list {Array}` - an array of items. The array form of `keyedById` Read only.
201201
- `find(params) {Function}` - a helper function that allows you to use the [Feathers Adapter Common API](https://docs.feathersjs.com/api/databases/common) and [Query API](https://docs.feathersjs.com/api/databases/querying) to pull data from the store. This allows you to treat the store just like a local Feathers database adapter (but without hooks).
202202
- `params {Object}` - an object with a `query` object and optional `paginate` and `temps` boolean properties. The `query` is in the FeathersJS query format. You can set `params.paginate` to `false` to disable pagination for a single request.
203-
- `count(params) {Function}` - a helper function that counts items in the store matching the provided query in the params and returns this number <Badge text="3.11.0+" />
203+
- `count(params) {Function}` - a helper function that counts items in the store matching the provided query in the params and returns this number <Badge text="3.12.0+" />
204204
- `params {Object}` - an object with a `query` object and an optional `temps` boolean property.
205205
- `get(id[, params]) {Function}` - a function that allows you to query the store for a single item, by id. It works the same way as `get` requests in Feathers database adapters.
206206
- `id {Number|String}` - the id of the data to be retrieved by id from the store.
@@ -296,7 +296,7 @@ See the section about pagination, below, for more information that is applicable
296296

297297
The `afterFind` action is called by the `find` action after a successful response is added to the store. It is called with the current response. By default, it is a no-op (it literally does nothing), and is just a placeholder for you to use when necessary. See the sections on [customizing the default store](#Customizing-a-Service’s-Default-Store) and [Handling custom server responses](./common-patterns.html#Handling-custom-server-responses) for example usage.
298298

299-
### `count(params)` <Badge text="3.11.0+" />
299+
### `count(params)` <Badge text="3.12.0+" />
300300

301301
Count items on the server matching the provided query.
302302

0 commit comments

Comments
 (0)