actions

Plugin for type-safe VanillaJS actions.

Import

import { actions } from '@wagmi/cli/plugins'

Usage

import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions(),
  ],
})

Configuration

import { type ActionsConfig } from '@wagmi/cli/plugins'

getActionName

'legacy' | ((options: { contractName: string; type: 'read' | 'simulate' | 'watch' | 'write' }) => `use${string}`)

• Function for setting custom hook names.
• Defaults to `${type}${contractName}`. For example, readErc20, simulateErc20, watchErc20Event, writeErc20.
• When 'legacy' (deprecated), hook names are set to @wagmi/cli@1 format.

import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions({
      getActionName({ contractName, type }) { 
        return `${contractName}__${type}`
      }, 
    }),
  ],
})

overridePackageName

'@wagmi/core' | 'wagmi'

• Override detected import source.
• Defaults to 'wagmi' or '@wagmi/core' depending on which package is installed.

import { defineConfig } from '@wagmi/cli'
import { actions } from '@wagmi/cli/plugins'

export default defineConfig({
  plugins: [
    actions({
      overridePackageName: 'wagmi', 
    }),
  ],
})