Type alias FallbackDeserializeFunction

FallbackDeserializeFunction: ((collection, pcdPackage, serializedPCD, deserializeError) => Promise<PCD>)

Function type for use in deserialization. This is a fallback option used when no PCD package is available, or when the named package fails to deserialize. It could wrap the PCD in a different type, or perform some more expensive parsing.

If the fallback function fails (throws) it will cause the deserialization to fail, in the same way (with the same error) as if there were no fallback at all.

Type declaration

    • (collection, pcdPackage, serializedPCD, deserializeError): Promise<PCD>

    • Parameters

      • collection: PCDCollection

        the PCDCollection performing the deserialization

      • pcdPackage: PCDPackage | undefined

        the package for the type of the serialized PCD, if any

      • serializedPCD: SerializedPCD

        the serialized PCD to deserialize

      • deserializeError: unknown

        the error thrown by the deserialize attempt

      Returns Promise<PCD>

Returns

a PCD representing or wrapping the serialized PCD

Throws

if no fallback deserialization is possible

Settings

Member Visibility

Theme

Generated using TypeDoc