Interface TArgumentIdentity<TArg, TPremise, TExpr, TVar>

Argument entity access and extras mutation.

interface TArgumentIdentity<
    TArg extends TCoreArgument = TCoreArgument,
    TPremise extends TCorePremise = TCorePremise,
    TExpr extends TCorePropositionalExpression = TCorePropositionalExpression,
    TVar extends TCorePropositionalVariable = TCorePropositionalVariable,
> {
    getArgument(): TArg;
    getExtras(): Record<string, unknown>;
    getRespondsTo(): | { argumentId: string; argumentVersion: number }
    | undefined;
    isResponse(): boolean;
    setExtras(
        extras: Record<string, unknown>,
    ): TCoreMutationResult<
        Record<string, unknown>,
        TExpr,
        TVar,
        TPremise,
        TArg,
    >;
    updateExtras(
        updates: Record<string, unknown>,
    ): TCoreMutationResult<
        Record<string, unknown>,
        TExpr,
        TVar,
        TPremise,
        TArg,
    >;
}

Type Parameters

TArg extends TCoreArgument = TCoreArgument
TPremise extends TCorePremise = TCorePremise
TExpr extends TCorePropositionalExpression = TCorePropositionalExpression
TVar extends TCorePropositionalVariable = TCorePropositionalVariable

Implemented by

ArgumentEngine

Index

Methods

getArgument getExtras getRespondsTo isResponse setExtras updateExtras

Methods

getArgument

getArgument(): TArg
Returns a shallow copy of the argument metadata with checksum attached.

Returns TArg
The argument entity.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1005

getExtras

getExtras(): Record<string, unknown>
Returns the argument's extra metadata record (all fields except id, version, checksums and respondsTo).

Returns Record<string, unknown>
The extras record.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1023

getRespondsTo

getRespondsTo(): { argumentId: string; argumentVersion: number } | undefined
The argument and version this response answers, or undefined for a standard argument. Set at construction and changed only by rebaseResponse.

Returns { argumentId: string; argumentVersion: number } | undefined
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1016

isResponse

isResponse(): boolean
Whether this argument is a response: it carries respondsTo and has no conclusion.

Returns boolean
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1010

setExtras

setExtras(
extras: Record<string, unknown>,
): TCoreMutationResult<Record<string, unknown>, TExpr, TVar, TPremise, TArg>
Replaces the argument's extra metadata record. A response's respondsTo is kept: it is owned by the engine, not an extra.
Parameters
- extras: Record<string, unknown>
  The new extras record.
Returns TCoreMutationResult<Record<string, unknown>, TExpr, TVar, TPremise, TArg>
The new extras record and a changeset with the modified argument.

Throws
If extras names respondsTo.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1032

updateExtras

updateExtras(
updates: Record<string, unknown>,
): TCoreMutationResult<Record<string, unknown>, TExpr, TVar, TPremise, TArg>
Shallow-merges updates into the argument's existing extras.
Parameters
- updates: Record<string, unknown>
  Key-value pairs to merge into the current extras.
Returns TCoreMutationResult<Record<string, unknown>, TExpr, TVar, TPremise, TArg>
The merged extras record and a changeset with the modified argument.
- Defined in src/lib/core/interfaces/argument-engine.interfaces.ts:1041