Type alias Component<RequiredComponents, ReturnType>

Type declaration

• Optional Readonly debugInfo?: object

  Optional data for debugging.

  Remarks

• Readonly dependencies: readonly ComponentName[]

  Remarks

  This field does not have the type of RequiredComponents[] because it will force the typing to be Invariance rather than Covariance.

  This field will be used mostly for debugging.

  See

  Wiki page on Covariance and contravariance

• Readonly name: Deferrable<string>

  Human readable name for the component.

  Remarks

  This field will be used mostly for debugging.

  It is common.Deferrable since sometimes its identification comes from a Deferrable parameter.

• Readonly router: BaseRouter

  The BaseRotuer object that this route belong to. Can be se to have more context.

• call:function

  • call(route): Promise<ReturnType>

  • Parameters

    • route: PartialRoute<RequiredComponents>

    Returns Promise<ReturnType>

• description:function

  • description(route): Promise<ComponentDescription>

  • Parameters

    • route: PartialRoute<RequiredComponents>

    Returns Promise<ComponentDescription>