Function deserialize

  • Deserializes a plain JavaScript object to an Opt instance.

    Type Parameters

    • T

    Parameters

    • x: unknown

      serialized Opt object (expected shape is OptSerialized)

    • guard: ((x) => x is T)

      function to validate the inner type

        • (x): x is T
        • Parameters

          • x: unknown

          Returns x is T

    Returns DeserializationResult<T>

    deserialization result as a DeserializationResult object

    Example

    deserialize({ type: 'Opt/None' }, isNumber) // { tag: 'success', value: none }
    deserialize({ type: 'Opt/Some', value: 0 }, isNumber) // { tag: 'success', value: some(0) }
    deserialize({ type: 'Opt/Some', value: 'not a number' }, isNumber) // { tag: 'failure', reason: 'failed to validate inner type' }

    See

    serialize

Generated using TypeDoc