Interface Target<TValue, TAsset, TContext>

Context entry definition target.

Passed to context entry to start the definition.

Allows to access context values and provide assets for them.

Type Parameters

TValue

Context value type.
TAsset = TValue

Context value asset type.
TContext extends CxValues = CxValues

Hierarchy

CxValues
CxModifier<TContext>
SupplyPeer
- Target

Index

Properties

context entry recentAsset supply

Methods

eachAsset eachRecentAsset get lazy provide trackAssetList trackAssets trackRecentAsset

Properties

`Readonly` context

context: TContext

Modified context.

`Readonly` entry

entry: CxEntry<TValue, TAsset>

Context entry to define.

`Readonly` recentAsset

recentAsset: undefined | TAsset

The most recent asset provided for the entry.

undefined when no assets provided.

`Readonly` supply

supply: Supply

Entry value supply.

The assets won't be provided any more when cut off. If applicable, disables the entry value.

This entry depends on context values supply.

Methods

eachAsset

eachAsset(callback): void
Iterates over value assets in the same order they are provided.

Passes each asset to the given callback function, until the latter returns false or there are no more assets.
Parameters
- callback: Callback<TAsset>
  
  Assets callback.
Returns void
- Defined in proc7ts/context-values/src/core/entry.ts:94

eachRecentAsset

eachRecentAsset(callback): void
Iterates over value assets with the most recent assets iterated first. I.e. in reverse order to the order they are provided.

Passes each asset to the given callback function until the latter returns false or there are no more assets.
Parameters
- callback: Callback<TAsset>
  
  Assets callback.
Returns void
- Defined in proc7ts/context-values/src/core/entry.ts:104

get

get<TValue>(entry, request?): TValue
Obtains value of the given context entry.
Type Parameters
- TValue
  
  Requested context value type.
Parameters
- entry: CxEntry<TValue, unknown>
  
  Context entry to obtain the value of.
- Optional request: WithoutFallback<TValue>
  
  Context value request with fallback specified.
Returns TValue
Either context entry value, or a fallback one.
Inherited from CxValues.get
- Defined in proc7ts/context-values/src/core/values.ts:17
get<TValue>(entry, request): TValue
Obtains value of the given context entry, or returns a non-nullable fallback.
Type Parameters
- TValue
  
  Requested context value type.
Parameters
- entry: CxEntry<TValue, unknown>
  
  Context entry to obtain the value of.
- request: WithFallback<TValue>
  
  Context value request with fallback specified.
Returns TValue
Either context entry value, or a fallback one.
Inherited from CxValues.get
- Defined in proc7ts/context-values/src/core/values.ts:28
get<TValue>(entry, request?): null | TValue
Obtains value of the given context entry, or returns a nullable fallback.

Throws
CxReferenceError - If the target entry has no value and fallback one is not provided.
Type Parameters
- TValue
  
  Requested context value type.
Parameters
- entry: CxEntry<TValue, unknown>
  
  Context entry to obtain the value of.
- Optional request: CxRequest<TValue>
  
  Context value request.
Returns null | TValue
Either context entry value, or a fallback one.
Inherited from CxValues.get
- Defined in proc7ts/context-values/src/core/values.ts:41

lazy

lazy<T>(evaluator): ((this) => T)
Creates a lazy evaluator against this entry definition target instance.
Type Parameters
- T
  
  Evaluation result type.
Parameters
- evaluator: ((this, target) => T)
  
  Evaluator function accepting this entry definition target instance as its only parameter and returning some result.
  - - (this, target): T
    - Parameters
      
      this: void
      
      target: Target<TValue, TAsset, TContext>
      
      Returns T
Returns ((this) => T)
A function without parameters returning the evaluated result. The result will be evaluated at most once.
- - (this): T
  - Creates a lazy evaluator against this entry definition target instance.
    Parameters
    - this: void
    Returns T
    A function without parameters returning the evaluated result. The result will be evaluated at most once.
- Defined in proc7ts/context-values/src/core/entry.ts:156

provide

provide<TValue, TAsset>(asset): Supply
Provides an asset for context entry.
Type Parameters
- TValue
  
  Context value type.
- TAsset = TValue
  
  Context value asset type.
Parameters
- asset: CxAsset<TValue, TAsset, TContext>
  
  Context entry asset.
Returns Supply
Asset supply. Revokes provided asset once cut off.
Inherited from CxModifier.provide
- Defined in proc7ts/context-values/src/core/modifier.ts:23

trackAssetList

trackAssetList(receiver, tracking?): Supply
Reads entry assets list and start tracking of their additions.

Sends a list of already provided assets to the given receiver, then sends it again on whenever asset provided or revoked, until the returned asset supply cut off.
Parameters
- receiver: ListReceiver<TAsset>
  
  Assets list receiver.
- Optional tracking: CxTracking
  
  Tracking options.
Returns Supply
Assets list supply. Stops tracking once cut off.
- Defined in proc7ts/context-values/src/core/entry.ts:145

trackAssets

trackAssets(receiver, tracking?): Supply
Reads entry assets and start tracking of their additions.

Sends already provided assets to the given receiver, then sends every added assets too, until the returned asset supply cut off.
Parameters
- receiver: CxAsset.Receiver<TAsset>
  
  Assets receiver.
- Optional tracking: CxTracking
  
  Tacking options.
Returns Supply
Assets supply. Stops tracking once cut off.
- Defined in proc7ts/context-values/src/core/entry.ts:117

trackRecentAsset

trackRecentAsset(receiver, tracking?): Supply
Reads the most recent entry asset and starts its tracking.

The most recent asset is the one with the smallest rank provided last.

Sends the recent asset to the given receiver, then sends again whenever the recent asset changes. Sends undefined when there are no assets provided for the entry.
Parameters
- receiver: RecentReceiver<TAsset>
  
  Most recent asset receiver.
- Optional tracking: CxTracking
  
  Tracking options.
Returns Supply
Most recent assets supply. Stops tracking once cut off.
- Defined in proc7ts/context-values/src/core/entry.ts:132

Interface Target<TValue, TAsset, TContext>

Type Parameters

TValue

TAsset = TValue

TContext extends CxValues = CxValues

Hierarchy

Index

Properties

Methods

Properties

Readonly context

Readonly entry

Readonly recentAsset

Readonly supply

Methods

eachAsset

Parameters

callback: Callback<TAsset>

Returns void

eachRecentAsset

Parameters

callback: Callback<TAsset>

Returns void

get

Type Parameters

TValue

Parameters

entry: CxEntry<TValue, unknown>

Optional request: WithoutFallback<TValue>

Returns TValue

Type Parameters

TValue

Parameters

entry: CxEntry<TValue, unknown>

request: WithFallback<TValue>

Returns TValue

Throws

Type Parameters

TValue

Parameters

entry: CxEntry<TValue, unknown>

Optional request: CxRequest<TValue>

Returns null | TValue

lazy

Type Parameters

T

Parameters

evaluator: ((this, target) => T)

Parameters

this: void

target: Target<TValue, TAsset, TContext>

Returns T

Returns ((this) => T)

Parameters

this: void

Returns T

provide

Type Parameters

TValue

TAsset = TValue

Parameters

asset: CxAsset<TValue, TAsset, TContext>

Returns Supply

trackAssetList

Parameters

receiver: ListReceiver<TAsset>

Optional tracking: CxTracking

Returns Supply

trackAssets

Parameters

receiver: CxAsset.Receiver<TAsset>

Optional tracking: CxTracking

Returns Supply

trackRecentAsset

Parameters

receiver: RecentReceiver<TAsset>

Optional tracking: CxTracking

Returns Supply

Settings

Member Visibility

`Readonly` context

`Readonly` entry

`Readonly` recentAsset

`Readonly` supply

`Optional` request: WithoutFallback<TValue>

`Optional` request: CxRequest<TValue>

`Optional` tracking: CxTracking

`Optional` tracking: CxTracking

`Optional` tracking: CxTracking