Usage
Signature:
interface SingleForeignKey<BD, FK extends keyof BD, JK>
Generic Parameters
Parameter Description BD Type of base data FK Foreign key as Pick JK Key to joined data
Typescript Import Format
//To use this interface, import as below.
import JoiningDataProvider= require("ojs/ojjoiningdataprovider");
//To access this interface in your code,
let myVariable: JoiningDataProvider.SingleForeignKey;
For additional information visit:
Fields
-
foreignKey :FK
-
A data attribute from which to get (or to be mapped to if a transform function is provided) the foreign key for a join.
- Since:
- 10.0.0
-
(nullable) transform :(key: object) => FK
-
An optional function that returns the foreign key for a join. The function will be passed the data from the attribute specified by the "foreignKey" property. If this is not specified, the value from foreignKey will be used as the foreign key.
- Since:
- 10.0.0