Skip to main content
Version: 1.1.0

IFieldValueResolver

@spartanfx/react v1.1.0


@spartanfx/react / codeapps / IFieldValueResolver

Interface: IFieldValueResolver

The two-method resolver returned by createFieldValueResolver / useFieldValueResolver.

Methods

encodeQueryValue()

encodeQueryValue(column, value): string;

Encode an optionset filter / query value for Dataverse: returns the numeric code as a string (so the OData $filter builder emits it unquoted, e.g. ps_department eq 223450000) when column is a known optionset and value is a known label; otherwise returns value unchanged. No-op for SharePoint. The label→code map is learned from reads (and entity metadata when available), so a read of the column must have happened first.

Parameters

column

string

value

string

Returns

string


invalidate()

invalidate(): void;

Clear cached probe results and metadata.

Returns

void


normalizeRecord()

normalizeRecord<T>(record): T;

Read-side flatten. Replaces SP reference objects and DV optionset numerics with their string label. Pure / synchronous / non-mutating. Safe to pass straight to Array.prototype.map.

Type Parameters

T

T extends Record<string, unknown>

Parameters

record

T

Returns

T


ready()

ready(): Promise<void>;

Resolves once read-side resolution data is loaded (the Dataverse optionset metadata). Immediate for SharePoint / services without getMetadata. Await this before normalizing a fresh page of reads so optionset codes resolve to labels on the first paint.

Returns

Promise<void>


resolveWritePayload()

resolveWritePayload<T>(record): Promise<T>;

Write-side expand. Strips #-suffix props, then (SharePoint) expands reference-column strings to { Value, Id, ... } or (Dataverse) converts optionset string labels to their numeric code and rewrites lookup columns from a GUID to <navProperty>@odata.bind.

Type Parameters

T

T extends Record<string, unknown>

Parameters

record

T

Returns

Promise<T>

Properties

PropertyModifierTypeDescription
modereadonlyCAResolverModeEffective backend mode (explicit or inferred). undefined when the service exposes neither capability.