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

useAvailability

Checks whether a name can be registered now. Signature, options, result and examples for useAvailability in @ensforge/react.

Read hookstable
Since v1.0.0View source

Checks whether a name can be registered now. Preset of useRead(Actions.registration.isAvailable, …).

It wraps registration.isAvailable: the same options, result and errors.

Signature

function useAvailability(options: Actions.registration.isAvailable.Options | undefined, config?: ReadConfig): ReadResult< Actions.registration.isAvailable.ReturnType, Actions.registration.isAvailable.ErrorType >

Examples

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

function View() {
  const { data: available } = useAvailability({ name: "alice.eth" })
  return <span>{String(available)}</span>
}

See also

  • The hook types: ReadResult, WriteResult and ReadConfig.

Was this page helpful?