Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeReact

usePermissions

Reads what an account may do with a name. Signature, options, result and examples for usePermissions in @ensforge/react.

Read hookstable
Since v1.0.0View source

Reads what an account may do with a name. Preset of useRead(Actions.permission.get, …).

It wraps permission.get: the same options, result and errors.

Signature

function usePermissions(options: Actions.permission.get.Options | undefined, config?: ReadConfig): ReadResult<Actions.permission.get.ReturnType, Actions.permission.get.ErrorType>

Examples

Reading in a component
import { usePermissions } from "@ensforge/react"

function View() {
  const { data: permissions } = usePermissions({ name: "alice.eth", account: address })
  return <span>{String(permissions?.can.setRecords)}</span>
}

See also

  • The hook types: ReadResult, WriteResult and ReadConfig.

Was this page helpful?