IObjRefMapConfig
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Configuration for the ObjRefMap.
export interface IObjRefMapConfig<T>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| (obj: T) => Identifier | (ALPHA) Function that extracts | |
| (obj: T) => ObjRef | (ALPHA) Function that extracts | |
| boolean | (ALPHA) Indicates whether strict idRef type-checking is desired. Some backends (e.g. tiger) have identifier refs use combination of On other backends, the | |
| (ALPHA) (Optional) Type of object stored in the map. | ||
| (obj: T) => string | (ALPHA) Function that extracts |
Property details
IObjRefMapConfig.idExtractpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Function that extracts id from object
readonly idExtract: (obj: T) => Identifier;
IObjRefMapConfig.refExtractpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Function that extracts ref from object
readonly refExtract: (obj: T) => ObjRef;
IObjRefMapConfig.strictTypeCheckpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Indicates whether strict idRef type-checking is desired. Some backends (e.g. tiger) have identifier refs use combination of id and type and have type-level id uniqueness constraints. On those backends, strict type checks are essential to correctly match objects.
On other backends, the type information coming in the idRef is superfluous and should not be influencing anything.
readonly strictTypeCheck: boolean;
IObjRefMapConfig.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Type of object stored in the map.
readonly type?: ObjectType;
IObjRefMapConfig.uriExtractpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Function that extracts uri from object
readonly uriExtract: (obj: T) => string;