Type alias LinkoutFunction<LinkoutData>

LinkoutFunction<LinkoutData>: ((linkoutData, options) => Promise<LinkoutResults>)

The signature of the function of the LisLinkoutElement class required for performing a linkout.

Type Parameters

LinkoutData
The type of the linkout function linkoutData parameter.

Type declaration

- (linkoutData, options): Promise<LinkoutResults>
- Parameters
  - linkoutData: LinkoutData
    The data to give to the linkout function.
  - options: LinkoutOptions
    Optional parameters that aren't required to perform a linkout but may be useful.
  Returns Promise<LinkoutResults>

Returns

A Promise that resolves to a LinkoutResults object.

Generated using TypeDoc