Interface UcrxContext

Charge processing context.

Hierarchy

UcrxContext

Index

Properties

data meta opaqueRx

Methods

onEntity onFormat onMeta reject

Properties

`Readonly` data

data: Record<PropertyKey, unknown>

Custom data passed to deserializer.

`Readonly` meta

Metadata for currently charged value.

`Readonly` opaqueRx

opaqueRx: Ucrx

Opaque charge receiver that ignores charge.

Used e.g. for unexpected charge after error reported.

Methods

onEntity

onEntity(entity): 0 | 1
Processes entity.
Parameters
- entity: string
  
  Entity to process represented as array of tokens.
Returns 0 | 1
Either 1 if entity recognized, or 0 for unrecognized entity.
- Defined in ucnot/churi/src/rx/ucrx-context.ts:43

onFormat

onFormat(format, data): 0 | 1
Processes formatted data.
Parameters
- format: string
  
  Name of format to process.
- data: readonly UcToken[]
  
  Formatted data tokens.
Returns 0 | 1
Either 1 if format and its data recognized, or 0 otherwise.
- Defined in ucnot/churi/src/rx/ucrx-context.ts:53

onMeta

onMeta(attribute): undefined | Ucrx
Processes metadata attribute.
Parameters
- attribute: string
  
  Metadata attribute name.
Returns undefined | Ucrx
Either metadata argument receiver, or undefined if metadata attribute can not be recognized.
- Defined in ucnot/churi/src/rx/ucrx-context.ts:62

reject

reject(rejection): 0
Rejects the charge.
Parameters
- rejection: UcRejection
  
  Rejection reason.
Returns 0
Always 0 to be able to return it from receiver's method.
- Defined in ucnot/churi/src/rx/ucrx-context.ts:34

Generated using TypeDoc