Triggers a query to re-run. This function updates the data provisioned by the GraphQL wire adapter imperatively.

refreshGraphql() enables you to control when you want the query to re-run, such as in response to a button click or via JavaScript. Call this function to send a GraphQL query request again to the server and update the client-side stored result set.

See the GraphQL query syntax.

The lwc-recipes repo has many GraphQL API examples. Look for components that start with graphql, such as graphqlRefresh.

A Promise object. The Promise isn’t resolved until the wire has received the latest data. The wire function might not be invoked again if the data that’s returned from the server hasn’t changed. Instead, wait for the Promise to resolve if you need to know when the refresh has completed. The actual value to which the Promise resolves is meaningless.

See Also