RecordCodec
Defined in: packages/common/src/codecs/composite/record.ts:9
Record codec - for string-keyed objects with homogeneous values
Extends
Section titled “Extends”Codec<Record<string,V>,Record<string,VEncoded>,WireObject<VEncoded>>
Type Parameters
Section titled “Type Parameters”V
VEncoded
Section titled “VEncoded”VEncoded = V
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RecordCodec<
V,VEncoded>(valueCodec):RecordCodec<V,VEncoded>
Defined in: packages/common/src/codecs/composite/record.ts:10
Parameters
Section titled “Parameters”valueCodec
Section titled “valueCodec”Codec<V, VEncoded>
Returns
Section titled “Returns”RecordCodec<V, VEncoded>
Overrides
Section titled “Overrides”Methods
Section titled “Methods”decode()
Section titled “decode()”decode(
value,format):T
Defined in: packages/common/src/codecs/codec.ts:46
Decode a value from wire format
Parameters
Section titled “Parameters”The wire value
WireObject<VEncoded> | null | undefined
format
Section titled “format”The wire format (json or msgpack)
Returns
Section titled “Returns”T
The decoded application value
Inherited from
Section titled “Inherited from”decodeOptional()
Section titled “decodeOptional()”decodeOptional(
value,format):Record<string,V> |undefined
Defined in: packages/common/src/codecs/codec.ts:60
Decode an optional value from wire format (preserves undefined vs default distinction)
Parameters
Section titled “Parameters”The wire value
WireObject<VEncoded> | null | undefined
format
Section titled “format”The wire format (json or msgpack)
Returns
Section titled “Returns”Record<string, V> | undefined
The decoded application value, or undefined if wire value was undefined
Inherited from
Section titled “Inherited from”defaultValue()
Section titled “defaultValue()”defaultValue():
Record<string,V>
Defined in: packages/common/src/codecs/composite/record.ts:14
The default value for this type (used to determine if a value should be omitted during encoding)
Returns
Section titled “Returns”Record<string, V>
Overrides
Section titled “Overrides”encode()
Section titled “encode()”encode(
value,format):TEncoded
Defined in: packages/common/src/codecs/codec.ts:23
Encode a value, always returning the value regardless of if it is default
Parameters
Section titled “Parameters”The application value
Record<string, V> | null | undefined
format
Section titled “format”The wire format (json or msgpack)
Returns
Section titled “Returns”TEncoded
The encoded value, or the default if it is undefined or null
Inherited from
Section titled “Inherited from”encodeOptional()
Section titled “encodeOptional()”encodeOptional(
value,format):Record<string,VEncoded> |undefined
Defined in: packages/common/src/codecs/codec.ts:34
Encode a value, omitting it if set to the default value.
Parameters
Section titled “Parameters”The application value
Record<string, V> | null | undefined
format
Section titled “format”The wire format (json or msgpack)
Returns
Section titled “Returns”Record<string, VEncoded> | undefined
The encoded value, or undefined if it equals the default (will be omitted)
Inherited from
Section titled “Inherited from”isDefaultValue()
Section titled “isDefaultValue()”isDefaultValue(
value):boolean
Defined in: packages/common/src/codecs/composite/record.ts:49
Check if a value equals the default value (determines if it should be omitted during encoding) Override this method for custom default comparison logic, otherwise defaults to default value equality
Parameters
Section titled “Parameters”Record<string, V>
The value to check
Returns
Section titled “Returns”boolean
True if value equals default