Hook Data Type Reference | Boundary Documentation

The HookData type represents the non-null data from a BAML React hook. This type is useful when you know the data exists and want to avoid undefined checks.

function Component() {
  const hook = useTestAws({
    stream: true, // optional, defaults to true
  })
  const data = hook.data;
  return (
    <div>
      {data} {/* No need for null checks */}
    </div>
  )
}

Type Parameters

FunctionName

generic

The name of the BAML function being called. Used to infer input and output types.

Options

{ stream?: boolean }

Configuration object that determines streaming behavior. Defaults to { stream?: true }.

Type Details

type

NonNullable<HookOutput<FunctionName, Options>['data']>

A utility type that removes undefined from the data property of HookOutput. This means the type will be either FinalDataType or StreamDataType depending on the streaming configuration.