`useRelationships`

The useRelationships hook returns the default Relationships object from the current Provider context (or a named one if an Id is provided).

useRelationships(id?: string): Relationships | undefined

Type Description

	Type	Description
`id?`	`string`	An optional `Id` of a named `Relationships` object in the Provider context.
returns	`Relationships \| undefined`	The `Relationships` object, or `undefined` if not found.

id?

string

An optional Id of a named Relationships object in the Provider context.

returns

Relationships | undefined

The Relationships object, or undefined if not found.

Since

v8.1.0