Skip to main content

Module: interfaces/Component

Interfaces

Type Aliases

BoundComponentFactory

Ƭ BoundComponentFactory<P, ShapeType>: BoundFunctionalComponentFactory<P, ShapeType> | BoundSetComponentFactory<P, ShapeType>

Type parameters

NameType
P{}
ShapeTypeextends Shape = Shape

Defined in

lincd/src/interfaces/Component.ts:171


Component

Ƭ Component<P, ShapeType>: ClassComponent<P, ShapeType> | LinkedFunctionalComponent<P, ShapeType> | LinkedFunctionalSetComponent<P, ShapeType>

Type parameters

NameType
Pany
ShapeTypeextends Shape = Shape

Defined in

lincd/src/interfaces/Component.ts:8


LinkableFunctionalComponent

Ƭ LinkableFunctionalComponent<P, ShapeType>: React.FC<P & LinkedComponentProps<ShapeType>>

Type parameters

NameType
PP
ShapeTypeextends Shape = Shape

Defined in

lincd/src/interfaces/Component.ts:53


LinkableFunctionalSetComponent

Ƭ LinkableFunctionalSetComponent<P, ShapeType>: React.FC<P & LinkedSetComponentProps<ShapeType>>

Type parameters

NameType
PP
ShapeTypeextends Shape = Shape

Defined in

lincd/src/interfaces/Component.ts:54


LinkedDataChildRequestFn

Ƭ LinkedDataChildRequestFn<T>: LinkedFunctionalComponent<T> | LinkedDataRequestFn<T>

Type parameters

Name
T

Defined in

lincd/src/interfaces/Component.ts:180


LinkedDataDeclaration

Ƭ LinkedDataDeclaration<T>: Object

Type parameters

Name
T

Type declaration

NameType
requestLinkedDataRequestFn<T>
shapetypeof Shape

Defined in

lincd/src/interfaces/Component.ts:176


LinkedDataRequest

Ƭ LinkedDataRequest: (PropertyShape | [PropertyShape, SubRequest])[]

An array of requested property shapes. If you want to request specific property shapes of another property shape (this is called a SubRequest) then replace a property shape with an array that contains the main property shape as the first element, and an array of property shapes as subRequest of that main property shape e.g.: [shape1,[shape2,[shape3,shape4]]] will request shape 3 & 4 of shape 2

Defined in

lincd/src/interfaces/Component.ts:196


LinkedDataRequestFn

Ƭ LinkedDataRequestFn<T>: (shapeOrShapeSet: T) => LinkedDataResponse

Type parameters

Name
T

Type declaration

▸ (shapeOrShapeSet): LinkedDataResponse

Parameters
NameType
shapeOrShapeSetT
Returns

LinkedDataResponse

Defined in

lincd/src/interfaces/Component.ts:181


LinkedDataResponse

Ƭ LinkedDataResponse: () => BoundComponentFactory<any, any> | (ResponseUnit | () => BoundComponentFactory<any, any> | ResponseUnit)[] | { [key: string]: ResponseUnit | () => BoundComponentFactory<any, any> | ResponseUnit; }

Defined in

lincd/src/interfaces/Component.ts:173


LinkedDataSetDeclaration

Ƭ LinkedDataSetDeclaration<T>: Object

Type parameters

NameType
Textends Shape

Type declaration

NameType
request?LinkedDataRequestFn<T>
setRequest?LinkedDataRequestFn<ShapeSet<T>>
shapetypeof Shape

Defined in

lincd/src/interfaces/Component.ts:183


ResponseUnit

Ƭ ResponseUnit: Node | Shape | string | number | ICoreIterable<Node | Shape | string | number>

Defined in

lincd/src/interfaces/Component.ts:172


SubRequest

Ƭ SubRequest: LinkedDataRequest

Defined in

lincd/src/interfaces/Component.ts:189


TransformedLinkedDataResponse

Ƭ TransformedLinkedDataResponse: BoundComponentFactory<any, any> | (ResponseUnit | BoundComponentFactory<any, any> | ResponseUnit)[] | { [key: string]: ResponseUnit | BoundComponentFactory<any, any> | ResponseUnit; }

Defined in

lincd/src/interfaces/Component.ts:174