@usine/engine/item-projection
Classes
Section titled “Classes”ItemProjection
Section titled “ItemProjection”The latest payload a trigger observed for one Item, whatever the source adapter.
Extends
Section titled “Extends”Schema.Class
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ItemProjection(…
args):ItemProjection
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
…args |
[props: object, options?: MakeOptions] |
Returns
Section titled “Returns”Properties
Section titled “Properties”contentHash
Section titled “contentHash”
readonlycontentHash:string&Brand<"ItemContentHash">
itemKey
Section titled “itemKey”
readonlyitemKey:string&Brand<"ItemKey">
number
Section titled “number”
readonlynumber:number&Brand<"ItemNumber">
payload
Section titled “payload”
readonlypayload:object
Index Signature
Section titled “Index Signature”[key: string]: Json
repository
Section titled “repository”
readonlyrepository:string&Brand<"RepositoryName">
source
Section titled “source”
readonlysource:string&Brand<"ItemProjectionSource">
ItemProjectionReader
Section titled “ItemProjectionReader”Extends
Section titled “Extends”Context.ServiceClass
Properties
Section titled “Properties”Service
Section titled “Service”
readonlyService:object
The service’s operations: what yield* ItemProjectionReader returns.
readonlylist: (repository,options) =>Effect.Effect<ReadonlyArray<ItemProjection>,EnginePersistenceError>
The newest limit Item projections of one repository, highest number first.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
repository |
RepositoryName |
options |
ItemProjectionListOptions |
Returns
Section titled “Returns”Effect.Effect<ReadonlyArray<ItemProjection>, EnginePersistenceError>
readonlystaticlayer:Layer<ItemProjectionReader,never,RunDatabase>
ItemProjectionWriter
Section titled “ItemProjectionWriter”Extends
Section titled “Extends”Context.ServiceClass
Properties
Section titled “Properties”Service
Section titled “Service”
readonlyService:object
The service’s operations: what yield* ItemProjectionWriter returns.
upsert
Section titled “upsert”
readonlyupsert: (item) =>Effect.Effect<boolean,EnginePersistenceError>
true means the durable projection changed.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
item |
ItemProjection |
Returns
Section titled “Returns”Effect.Effect<boolean, EnginePersistenceError>
readonlystaticlayer:Layer<ItemProjectionWriter,never,RunDatabase>
Interfaces
Section titled “Interfaces”ItemProjectionListOptions
Section titled “ItemProjectionListOptions”Newest Items first. The bound keeps a long-lived repository’s Board response finite.
Properties
Section titled “Properties”
readonlylimit:number
Type Aliases
Section titled “Type Aliases”ItemContentHash
Section titled “ItemContentHash”ItemContentHash = typeof
ItemContentHash.Type
ItemProjectionSource
Section titled “ItemProjectionSource”ItemProjectionSource = typeof
ItemProjectionSource.Type
Variables
Section titled “Variables”ItemContentHash
Section titled “ItemContentHash”
constItemContentHash:Schema.brand<Schema.NonEmptyString,"ItemContentHash">
ItemProjectionSource
Section titled “ItemProjectionSource”
constItemProjectionSource:Schema.brand<Schema.NonEmptyString,"ItemProjectionSource">