ucs-exchange-object

UCS Exchange Object

Usage no npm install needed!

<script type="module">
  import ucsExchangeObject from 'https://cdn.skypack.dev/ucs-exchange-object';
</script>

README

UcsExchangeObject is used for communication between UcsPublisher plugins - each plugin is an independent application which gets it on the input and outputs its modified, serialized version to the next plugins input.

Generally it looks like:


{
    registry: {
        data: {}, errors: []
    },
    modifiedObject: {},
    originalObject: {}
}



You can find API documentation in doc/html.zip

registry key contains logs, errors and any temporary data saved by plugins

modifiedObject - if you want to change anything in the publication package, you have to modify this object

originalObject - this is original publication package got from storage by PublishRouter, you can not modify this object

** WARNING: to modify any property of this object you should use only methods provided by UcsExchangeObject class**