@openfabr/cdf / Exports / RelationConfig

Interface: RelationConfig

Interface for a relation segment in the configuration. It is expected to be extended by packages to carry detailed information about a particular relation type.

Hierarchy

• NameAware

• TypeAware

↳ RelationConfig

Table of contents

Properties

• bidi
• finish
• name
• start
• type

Properties

bidi

• Readonly bidi: boolean

Indicating whether the relation is bidirectional, i.e. no directional difference between start and end points.

Defined in

src/lib/config.ts:52

finish

• Readonly finish: string

The end of a relation, specified by the name of a service or component defined in the same configuration.

Defined in

src/lib/config.ts:48

name

• Readonly name: string

Inherited from

NameAware.name

Defined in

src/lib/domain.ts:77

start

• Readonly start: string

The start of a relation, specified by the name of a service or component defined in the same configuration.

Defined in

src/lib/config.ts:44

type

• Readonly type: string

Inherited from

TypeAware.type

Defined in

src/lib/domain.ts:87