Class Shareable<TBody, TSharer>

Abstract implementation of value shareable by component.

Shareable instance contains a body that become usable only when bound to sharer component.

Type Parameters

TBody = unknown

Shareable body type.
TSharer extends object = any

Sharer component type.

Hierarchy

Shareable

Implements

EventKeeper<[TBody]>
SharerAware

Index

Constructors

constructor

new Shareable<TBody, TSharer>(body: TBody | Shareable.Provider<TBody, TSharer>): Shareable<TBody, TSharer>
Constructs shareable instance.
Type Parameters
- TBody = unknown
- TSharer extends object = any
Parameters
- body: TBody | Shareable.Provider<TBody, TSharer>
  
  Either shareable body, or its provider.
Returns Shareable<TBody, TSharer>
- Defined in wesib/generic/src/shares/shareable.ts:53

Properties

`Private` `Internal` [Shareable$Internals__symbol]

[Shareable$Internals__symbol]: Shareable$Internals<TBody, TSharer>

Accessors

body

get body(): TBody
Shareable body.

Accessing is throws an exception until bound to sharer.

Returns TBody
- Defined in wesib/generic/src/shares/shareable.ts:93

read

get read(): AfterEvent<[TBody]>
An AfterEvent keeper of shareable body.

An [AfterEvent__symbol] method always returns this value.

Returns AfterEvent<[TBody]>
- Defined in wesib/generic/src/shares/shareable.ts:71

sharer

get sharer(): ComponentContext<TSharer>
Sharer component context.

Accessing it throws an exception until bound to sharer.

Returns ComponentContext<TSharer>
- Defined in wesib/generic/src/shares/shareable.ts:62

Methods

[AfterEvent__symbol]

[AfterEvent__symbol](): AfterEvent<[TBody]>
Returns AfterEvent<[TBody]>
Implementation of EventKeeper.__@AfterEvent__symbol@22864
- Defined in wesib/generic/src/shares/shareable.ts:84

sharedBy

sharedBy(sharer: ComponentContext<TSharer>): void
Informs this shareable instance on its sharer component.
Parameters
- sharer: ComponentContext<TSharer>
  
  Sharer component context.
Returns void
Implementation of SharerAware.sharedBy
- Defined in wesib/generic/src/shares/shareable.ts:80

`Static` provider

provider<TBody, TSharer>(body: TBody | Shareable.Provider<TBody, TSharer>): ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)
Converts shareable body or its provider to provider that always returns an AfterEvent keeper of shareable body.

Returns
Shareable body provider.
Type Parameters
- TBody = unknown
  
  Shareable body type.
- TSharer extends object = any
  
  Sharer component type.
Parameters
- body: TBody | Shareable.Provider<TBody, TSharer>
  
  Either shareable body, or its provider.
Returns ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)
- - (this: void, sharer: ComponentContext<TSharer>): AfterEvent<[TBody]>
  - Converts shareable body or its provider to provider that always returns an AfterEvent keeper of shareable body.
    
    Returns
    Shareable body provider.
    Parameters
    - this: void
    - sharer: ComponentContext<TSharer>
    Returns AfterEvent<[TBody]>
- Defined in wesib/generic/src/shares/shareable.ts:35

Class Shareable<TBody, TSharer>

Type Parameters

TBody = unknown

TSharer extends object = any

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TBody = unknown

TSharer extends object = any

Parameters

body: TBody | Shareable.Provider<TBody, TSharer>

Returns Shareable<TBody, TSharer>

Properties

Private Internal [Shareable$Internals__symbol]

Accessors

body

Returns TBody

read

Returns AfterEvent<[TBody]>

sharer

Returns ComponentContext<TSharer>

Methods

[AfterEvent__symbol]

Returns AfterEvent<[TBody]>

sharedBy

Parameters

sharer: ComponentContext<TSharer>

Returns void

Static provider

Returns

Type Parameters

TBody = unknown

TSharer extends object = any

Parameters

body: TBody | Shareable.Provider<TBody, TSharer>

Returns ((this: void, sharer: ComponentContext<TSharer>) => AfterEvent<[TBody]>)

Returns

Parameters

this: void

sharer: ComponentContext<TSharer>

Returns AfterEvent<[TBody]>

Settings

Member Visibility

Theme

`Private` `Internal` [Shareable$Internals__symbol]

`Static` provider