@eluvio/elv-js-helpers/test/unit/jsdoc_examples/Functional/liftA2.jsdoc.test.js

A collection of Javascript helper functions used by several Eluvio libraries.

// AUTO-GENERATED TEST - DO NOT MODIFY, CHANGES WILL BE OVERWRITTEN DURING BUILD
'use strict'
const TH = require('../../../test-helpers')
const liftA2 = TH.requireSrcFile('Functional/liftA2')

describe('liftA2 JSDoc example', () => {
  it('should execute correctly as described', () => {
    'use strict'
    const curry = TH.requireSrcFile('Functional/curry')
    const dumpJSON = TH.requireSrcFile('Misc/dumpJSON')
    const Err = TH.requireSrcFile('ADT/Err')
    const Ok = TH.requireSrcFile('ADT/Ok')
    const resultToPOJO = TH.requireSrcFile('Conversion/resultToPOJO')
    // define a function that takes and returns 'normal' values:
    const mult = (a, b) => a * b
    mult(42, 42).should.eql(1764)
    // convert function 'mult' into one that works with values wrapped in Functional data types
    const liftedMult = liftA2(curry(mult))
    // create a wrapped good input
    const okObject = Ok(42)
    // create 2 wrapped errors indicating input failures:
    // non-array input automatically converted to single element array
    const errObject1 = Err('failed to obtain first input')
    const errObject2 = Err(['failed to obtain second input'])
    const goodResult = liftedMult(okObject, okObject)
    goodResult.inspect().should.eql('Ok 1764')
    resultToPOJO(goodResult).should.eql({ok: true, value: 1764})
    // call lifted function using 1 bad input:
    const badResult1 = liftedMult(errObject1, okObject)
    resultToPOJO(badResult1).ok.should.eql(false)
    resultToPOJO(badResult1).errMsgs.should.eql(['failed to obtain first input'])
    const badResult2 = liftedMult(okObject, errObject2)
    resultToPOJO(badResult2).ok.should.eql(false)
    resultToPOJO(badResult2).errMsgs.should.eql(['failed to obtain second input'])
    // call lifted function using 2 bad inputs:
    const badResult3 = liftedMult(errObject1, errObject2)
    resultToPOJO(badResult3).ok.should.eql(false)
    resultToPOJO(badResult3).errMsgs.should.eql(['failed to obtain first input', 'failed to obtain second input'])

    TH.sinon.stub(console, 'log')
    dumpJSON(resultToPOJO(badResult3))
    try {
      TH.chai.assert.deepEqual(
        console.log.getCall(0).args[0],
        `{\n  "ok": false,\n  "errMsgs": [\n    "failed to obtain first input",\n    "failed to obtain second input"\n  ],\n  "errors": [\n    "failed to obtain first input",\n    "failed to obtain second input"\n  ]\n}`
      )
    } finally {
      TH.sinon.restore()
    }
    // liftA2 itself is curried, it can be called with 1-3 arguments as desired. If called with 3 arguments, it will
    // immediately return the final result instead of returning a function.
    liftA2(curry(mult), okObject, okObject).inspect().should.eql('Ok 1764')
  })
})