Saxon » SaxonJS

Unit test nodejs/saxonapi async-trans-007 added to reproduce the bug.

It turns out that for an asynchronous transform, we are actually still returning the updated options object, rather than just a transform results object (see https://www.saxonica.com/saxon-js/documentation2/index.html#!api/transform/results). I don't think this is what is intended. The options object will have been updated to add principalResult and resultDocuments, but stylesheetInternal is not updated (so it is only defined if this was supplied in the first place).

Note that in the documentation, under "Synchronous and asynchronous execution" (https://www.saxonica.com/saxon-js/documentation2/index.html#!api/transform/execution), it says:

If the second argument is the string "async" then the function fires off the transformation asynchronously, returning a Promise. The promise is fulfilled when the transformation completes, successfully or unsuccessfully. On successful completion, the value passed to the resolution function is the options object, updated to contain result information.

But I think that final sentence also needs updating. Elsewhere we always refer to the results object, e.g. lower on the page:

The argument supplied to the then method of the Promise is the JavaScript Object described at Transformation Results.