Function createUseNetworkObjectStateHook

createUseNetworkObjectStateHook<THookParams extends unknown[]>(
    ...createArgs: [
        getNetworkObject: (
            ...args: THookParams,
        ) => Promise<undefined | NetworkObject<object>>,
        mapParametersToNetworkObjectSource?: (
            ...args: THookParams,
        ) => undefined | string | NetworkObject<object>,
        doesCreatedNetworkObjectMatchSource?: (
            networkObjectDetails: NetworkObjectDetails,
            networkObjectSource: string,
        ) => boolean,
    ],
): (...args: THookParams) => NetworkObjectState<NetworkObject<object>>
Creates a hook that returns a NetworkObjectState for a source — which of "nothing asked", "in flight", "here it is", and "not available" the lookup is in, so a consumer can wait out a transient window, report a dead end, and act only on an object that answers the source it is asking about right now.

Shares its implementation with createUseNetworkObjectHook, so re-lookup on disposal and on factory publication behave identically.
Type Parameters
- THookParams extends unknown[]
Parameters
- ...createArgs: [
      getNetworkObject: (
          ...args: THookParams,
      ) => Promise<undefined | NetworkObject<object>>,
      mapParametersToNetworkObjectSource?: (
          ...args: THookParams,
      ) => undefined | string | NetworkObject<object>,
      doesCreatedNetworkObjectMatchSource?: (
          networkObjectDetails: NetworkObjectDetails,
          networkObjectSource: string,
      ) => boolean,
  ]
Returns (...args: THookParams) => NetworkObjectState<NetworkObject<object>>
A function that takes in a networkObjectSource and returns its state
- Defined in lib/papi-dts/papi.d.ts:10583

Function createUseNetworkObjectStateHook

Type Parameters

Parameters

Returns (...args: THookParams) => NetworkObjectState<NetworkObject<object>>

Settings