You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-components.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,8 +93,8 @@ The `FeathersVuexFind` component retrieves data from the API server, puts it in
93
93
-`query {Object}` <Badgetext="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.
94
94
-`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: []**
95
95
-`fetchQuery {Object}` <Badgetext="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. <Badgetext="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. <Badgetext="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. <Badgetext="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. <Badgetext="3.12.0+" />
98
98
-`queryWhen {Boolean|Function}` - the query to the server will only be made when this evaluates to true. **Default: true**
99
99
-`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**
100
100
-`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 {
165
165
-`item {Object}` - The resulting record for the get operation.
166
166
-`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.
167
167
168
-
## FeathersVuexCount <Badgetext="3.11.0+" />
168
+
## FeathersVuexCount <Badgetext="3.12.0+" />
169
169
170
170
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.
Copy file name to clipboardExpand all lines: docs/model-classes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -156,7 +156,7 @@ created () {
156
156
}
157
157
```
158
158
159
-
### count(params) <Badgetext="3.11.0+" />
159
+
### count(params) <Badgetext="3.12.0+" />
160
160
161
161
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).
162
162
@@ -172,7 +172,7 @@ async created () {
172
172
}
173
173
```
174
174
175
-
### countInStore(params) <Badgetext="3.11.0+" />
175
+
### countInStore(params) <Badgetext="3.12.0+" />
176
176
177
177
Model classes have a `countInStore` method, which is a proxy to the [`count` getter](./service-plugin.html#Service-Getters).
Copy file name to clipboardExpand all lines: docs/service-plugin.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -200,7 +200,7 @@ Service modules include the following getters:
200
200
-`list {Array}` - an array of items. The array form of `keyedById` Read only.
201
201
-`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).
202
202
-`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 <Badgetext="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 <Badgetext="3.12.0+" />
204
204
-`params {Object}` - an object with a `query` object and an optional `temps` boolean property.
205
205
-`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.
206
206
-`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
296
296
297
297
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.
298
298
299
-
### `count(params)` <Badgetext="3.11.0+" />
299
+
### `count(params)` <Badgetext="3.12.0+" />
300
300
301
301
Count items on the server matching the provided query.
0 commit comments