papi-dts
    Preparing search index...
    • This function takes in a getNetworkObject function and creates a hook with that function in it which will return a network object

      Type Parameters

      • THookParams extends unknown[]

      Parameters

      • getNetworkObject: (...args: THookParams) => Promise<undefined | NetworkObject<object>>

        A function that takes in an id string and returns a network object

      • OptionalmapParametersToNetworkObjectSource: (...args: THookParams) => undefined | string | NetworkObject<object>

        Function that takes the parameters passed into the hook and returns the networkObjectSource associated with those parameters. Defaults to taking the first parameter passed into the hook and using that as the networkObjectSource.

        • Note: networkObjectSource is string name of the network object to get OR networkObject (result of this hook, if you want this hook to just return the network object again)
      • OptionaldoesCreatedNetworkObjectMatchSource: (
            networkObjectDetails: NetworkObjectDetails,
            networkObjectSource: string,
        ) => boolean

        Function that decides whether a network object that was just created on the network means the hook should look its source up again. Defaults to comparing the new object's id to the networkObjectSource.

        • MUST be supplied by any caller whose networkObjectSource is not literally the id the object is registered under — a data provider name becomes {name}-data, a web view id becomes webViewController{id}, and so on. Left at the default, such a hook's re-lookup listener compares two strings that can never be equal, so it never fires and the hook is left with the single re-lookup a disposal drives.

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

      A function that takes in a networkObjectSource and returns a NetworkObject