Skip to content

chore: update .connect to .mutate #4686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

chore: update .connect to .mutate #4686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6dc0138
chore: update .connect to .mutate
o-az May 26, 2025
b021c1c
chore: update tests to use .mutate
o-az May 26, 2025
3406f91
chore(vue): update .connect to .mutate
o-az May 26, 2025
afc8a2e
chore(vue): update tests to use .mutate
o-az May 26, 2025
ded2ee4
chore(docs): update react & vue to connect.mutate
o-az May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/react/src/hooks/useAccountEffect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ test('behavior: connect and disconnect called once', async () => {
useDisconnect: useDisconnect(),
}))

result.current.useConnect.connect({
result.current.useConnect.mutate({
connector: result.current.useConnect.connectors[0]!,
})
await waitFor(() => expect(result.current.useConnect.isSuccess).toBeTruthy())

result.current.useConnect.connect({
result.current.useConnect.mutate({
connector: result.current.useConnect.connectors[0]!,
})
await waitFor(() => expect(result.current.useConnect.isSuccess).toBeTruthy())
Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/hooks/useConnect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ test('default', async () => {
expect(result.current.useAccount.address).not.toBeDefined()
expect(result.current.useAccount.status).toEqual('disconnected')

result.current.useConnect.connect({
result.current.useConnect.mutate({
connector: result.current.useConnect.connectors[0]!,
})

Expand Down
4 changes: 4 additions & 0 deletions packages/react/src/hooks/useConnect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,13 @@ export type UseConnectReturnType<
ConnectVariables<config, config['connectors'][number]>,
context
> & {
/** @deprecated use mutate */
connect: ConnectMutate<config, context>
/** @deprecated use mutateAsync */
connectAsync: ConnectMutateAsync<config, context>
connectors: Compute<UseConnectorsReturnType> | config['connectors']
mutate: ConnectMutate<config, context>
mutateAsync: ConnectMutateAsync<config, context>
}
>

Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/hooks/useConnectorClient.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ test('behavior: connect and disconnect', async () => {

expect(result.current.useConnectorClient.data).not.toBeDefined()

result.current.useConnect.connect({
result.current.useConnect.mutate({
connector: result.current.useConnect.connectors[0]!,
})

Expand Down
2 changes: 1 addition & 1 deletion packages/react/src/hooks/useDisconnect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ test('default', async () => {
expect(result.current.useAccount.address).toBeDefined()
expect(result.current.useAccount.status).toEqual('connected')

result.current.useDisconnect.disconnect()
result.current.useDisconnect.mutate()

await waitFor(() =>
expect(result.current.useAccount.isDisconnected).toBeTruthy(),
Expand Down
6 changes: 6 additions & 0 deletions packages/react/src/hooks/useDisconnect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,12 @@ export type UseDisconnectReturnType<context = unknown> = Compute<
context
> & {
connectors: readonly Connector[]
/** @deprecated use mutate */
disconnect: DisconnectMutate<context>
/** @deprecated use mutateAsync */
disconnectAsync: DisconnectMutateAsync<context>
mutate: DisconnectMutate<context>
mutateAsync: DisconnectMutateAsync<context>
}
>

Expand All @@ -66,5 +70,7 @@ export function useDisconnect<context = unknown>(
),
disconnect: mutate,
disconnectAsync: mutateAsync,
mutate,
mutateAsync,
}
}
2 changes: 1 addition & 1 deletion packages/react/src/hooks/useWalletClient.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ test('behavior: connect and disconnect', async () => {

expect(result.current.useWalletClient.data).not.toBeDefined()

result.current.useConnect.connect({
result.current.useConnect.mutate({
connector: result.current.useConnect.connectors[0]!,
})

Expand Down
8 changes: 4 additions & 4 deletions packages/vue/src/composables/useAccountEffect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ test('behavior: connect and disconnect called once', async () => {
const [connect] = renderComposable(() => useConnect())
const [disconnect] = renderComposable(() => useDisconnect())

connect.connect({
connect.mutate({
connector: connect.connectors[0]!,
})
await waitFor(connect.isSuccess)
connect.connect({
connect.mutate({
connector: connect.connectors[0]!,
})

disconnect.disconnect()
disconnect.mutate()
await waitFor(disconnect.isSuccess)
disconnect.disconnect()
disconnect.mutate()

expect(onConnect).toBeCalledTimes(1)
expect(onDisconnect).toBeCalledTimes(1)
Expand Down
2 changes: 1 addition & 1 deletion packages/vue/src/composables/useConnect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ test('default', async () => {
expect(account.address.value).not.toBeDefined()
expect(account.status.value).toEqual('disconnected')

connect.connect({
connect.mutate({
connector: connect.connectors[0]!,
})

Expand Down
4 changes: 4 additions & 0 deletions packages/vue/src/composables/useConnect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,13 @@ export type UseConnectReturnType<
ConnectVariables<config, config['connectors'][number]>,
context
> & {
/** @deprecated use `mutate` instead */
connect: ConnectMutate<config, context>
/** @deprecated use `mutateAsync` instead */
connectAsync: ConnectMutateAsync<config, context>
connectors: Compute<GetConnectorsReturnType> | config['connectors']
mutate: ConnectMutate<config, context>
mutateAsync: ConnectMutateAsync<config, context>
}
>

Expand Down
4 changes: 2 additions & 2 deletions packages/vue/src/composables/useConnectorClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ test('behavior: connect and disconnect', async () => {

expect(client.data.value).not.toBeDefined()

connect.connect({
connect.mutate({
connector: connect.connectors[0]!,
})

await waitFor(client.data, (data) => data !== undefined)

disconnect.disconnect()
disconnect.mutate()

await waitFor(client.data, (data) => data === undefined)
})
Expand Down
6 changes: 6 additions & 0 deletions packages/vue/src/composables/useDisconnect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,12 @@ export type UseDisconnectReturnType<context = unknown> = Compute<
context
> & {
connectors: Ref<readonly Connector[]>
/** @deprecated use `mutate` instead */
disconnect: DisconnectMutate<context>
/** @deprecated use `mutateAsync` instead */
disconnectAsync: DisconnectMutateAsync<context>
mutate: DisconnectMutate<context>
mutateAsync: DisconnectMutateAsync<context>
}
>

Expand All @@ -66,5 +70,7 @@ export function useDisconnect<context = unknown>(
),
disconnect: mutate,
disconnectAsync: mutateAsync,
mutate,
mutateAsync,
}
}
10 changes: 5 additions & 5 deletions site/react/api/hooks/useConnect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Hook for connecting accounts with connectors.
const packageName = 'wagmi'
const actionName = 'connect'
const typeName = 'Connect'
const mutate = 'connect'
const mutate = 'mutate'
const TData = '{ accounts: readonly [Address, ...Address[]]; chainId: number; }'
const TError = 'ConnectErrorType'
const TVariables = '{ chainId?: number | undefined; connector?: CreateConnectorFn | Connector | undefined; }'
Expand All @@ -31,10 +31,10 @@ import { useConnect } from 'wagmi'
import { injected } from 'wagmi/connectors'

function App() {
const { connect } = useConnect()
const { mutate } = useConnect()

return (
<button onClick={() => connect({ connector: injected() })}>
<button onClick={() => mutate({ connector: injected() })}>
Connect
</button>
)
Expand Down Expand Up @@ -88,12 +88,12 @@ Globally configured connectors via [`createConfig`](/react/api/createConfig#conn
import { useConnect } from 'wagmi'

function App() {
const { connect, connectors } = useConnect()
const { mutate, connectors } = useConnect()

return (
<div>
{connectors.map((connector) => (
<button key={connector.id} onClick={() => connect({ connector })}>
<button key={connector.id} onClick={() => mutate({ connector })}>
{connector.name}
</button>
))}
Expand Down
2 changes: 1 addition & 1 deletion site/react/api/hooks/useDisconnect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Hook for disconnecting connections.
const packageName = 'wagmi'
const actionName = 'disconnect'
const typeName = 'Disconnect'
const mutate = 'disconnect'
const mutate = 'mutate'
const TData = 'void'
const TError = 'DisconnectErrorType'
const TVariables = '{ connector?: Connector | undefined; }'
Expand Down
2 changes: 1 addition & 1 deletion site/vue/api/composables/useConnect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Composable for connecting accounts with connectors.
const packageName = '@wagmi/vue'
const actionName = 'connect'
const typeName = 'Connect'
const mutate = 'connect'
const mutate = 'mutate'
const TData = '{ accounts: readonly [Address, ...Address[]]; chainId: number; }'
const TError = 'ConnectErrorType'
const TVariables = '{ chainId?: number | undefined; connector?: CreateConnectorFn | Connector | undefined; }'
Expand Down
2 changes: 1 addition & 1 deletion site/vue/api/composables/useDisconnect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Composable for disconnecting connections.
const packageName = '@wagmi/vue'
const actionName = 'disconnect'
const typeName = 'Disconnect'
const mutate = 'disconnect'
const mutate = 'mutate'
const TData = 'void'
const TError = 'DisconnectErrorType'
const TVariables = '{ connector?: Connector | undefined; }'
Expand Down
Loading