Interface $Codec<S, D>

A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.

interface $Codec<S, D> {
    createDeserializer(): $ShapeDeserializer<D>;
    createSerializer(): $ShapeSerializer<S>;
    setSerdeContext(serdeContext: SerdeFunctions): void;
}

Type Parameters

S
D

Hierarchy (View Summary)

ConfigurableSerdeContext
- $Codec

Index

Methods

createDeserializer createSerializer setSerdeContext

Methods

createDeserializer

createDeserializer(): $ShapeDeserializer<D>
Returns $ShapeDeserializer<D>
- Defined in node_modules/@smithy/types/dist-types/schema/schema.d.ts:157

createSerializer

createSerializer(): $ShapeSerializer<S>
Returns $ShapeSerializer<S>
- Defined in node_modules/@smithy/types/dist-types/schema/schema.d.ts:156

setSerdeContext

setSerdeContext(serdeContext: SerdeFunctions): void
Parameters
- serdeContext: SerdeFunctions
Returns void
Inherited from ConfigurableSerdeContext.setSerdeContext
- Defined in node_modules/@smithy/types/dist-types/schema/schema.d.ts:235