Skip to main content
Version: v2

ValueRequiredState Interface

Represents a state that must have a value. And it includes standard metadata.

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature​

interface ValueRequiredState<TValue> extends ValueStateMetadata

Extends: ValueStateMetadata

Type Parameters​

ParameterDescription
TValue

Remarks​

The value is wrapped in OpaqueJsonDeserialized as uses are expected to involve generic or unknown types that will be filtered. It is here mostly as a convenience to the many such uses that would otherwise need to specify some wrapper themselves.

For known cases, construct a custom interface that extends ValueStateMetadata.

Properties​

PropertyTypeDescription
valueOpaqueJsonDeserialized<TValue>

Property Details​

value​

This API is reserved for internal system use and should not be imported directly. It may change at any time without notice.

For more information about our API support guarantees, see here.

Signature​

value: OpaqueJsonDeserialized<TValue>;

Type: OpaqueJsonDeserialized<TValue>