Interface MutationPort<T>

Application persistence. Successful writes return canonical entities.

interface MutationPort<T> {
    create?(
        request: { candidate: T },
        ctx: MutationContext,
    ): Promise<MutationOutcome<T>>;
    remove?(
        request: { entity: T },
        ctx: MutationContext,
    ): Promise<RemoveMutationOutcome>;
    update?(
        request: { candidate: T; changes: ChangeSet<T>; original: T },
        ctx: MutationContext,
    ): Promise<MutationOutcome<T>>;
}

Type Parameters

T

Index

Methods

create? remove? update?

Methods

`Optional`create

create?(
request: { candidate: T },
ctx: MutationContext,
): Promise<MutationOutcome<T>>
Parameters
- request: { candidate: T }
- ctx: MutationContext
Returns Promise<MutationOutcome<T>>

`Optional`remove

remove?(
request: { entity: T },
ctx: MutationContext,
): Promise<RemoveMutationOutcome>
Parameters
- request: { entity: T }
- ctx: MutationContext
Returns Promise<RemoveMutationOutcome>

`Optional`update

update?(
request: { candidate: T; changes: ChangeSet<T>; original: T },
ctx: MutationContext,
): Promise<MutationOutcome<T>>
Parameters
- request: { candidate: T; changes: ChangeSet<T>; original: T }
- ctx: MutationContext
Returns Promise<MutationOutcome<T>>