npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jest-mock-curry-fn

v0.0.3

Published

[![npm version](https://badge.fury.io/js/jest-mock-curry-fn.svg)](https://badge.fury.io/js/jest-mock-curry-fn)

Downloads

561

Readme

jest-mock-curry-fn

npm version

Easier testing with curry functions + jest 🧪

Who's it for?

  1. You use curried functions (see more: Curry and Function Composition)
  2. You would like to mock away certain curried functions (eg. XHR calls) for ease of testing
  3. You need unit tests to assert that these curried functions are called correctly
  4. You don't want to write so much setup code for testing curried functions

Scenario

// makeName.ts
export const makeName = (name) => {
  const prefix = stringPrefixer('first')('second')
  const result = `${prefix} ${name}`
  return result
}

// stringPrefixer.ts
export const stringPrefixer = (first) => (second) => {
  return `${first}-${second}`
}

Scenario:

  • System Under Test is makeName()
  • When makeName() is called (eg. makeName('whee!)),
  • Then we expect that stringPrefixer has been called with:
    • 1st mock: ('first')
    • 2nd mock: ('second')
    • Returned value: hey! whee!

Usage

// 1. import makeMockCurryFn()
import { makeMockCurryFn } from 'jest-mock-curry-fn'

// 2. import function under test
import { makeName } from './makeName'

// 3. import underlying function that requires mocking
import * as stringPrefixerImport from './stringPrefixer'

test('asserts curry fn is called', () => {
  // 4. create mocked curry fn
  const mockStringPrefixerFn = makeMockCurryFn({
    nCurriedFns: 2,
    tailFnReturnValue: 'hey!',
  })

  // 5. mock stringPrefixer() usage
  jest
    .spyOn(stringPrefixerImport, 'stringPrefixer')
    .mockImplementation(mockStringPrefixerFn.headMockFn)

  // 6. trigger usage of top-level function
  const result = makeName('whee!')

  // 7. assert curry fn calls
  mockStringPrefixerFn.expectMockFnsCalledWith('first')('second')

  // 8. assert return value
  expect(result).toEqual('hey! whee!')
})

See more: sampleUsage.test.ts

API

const options = {
  // required: number of nested curried fns, must be >= 1
  nCurriedFns: 2,
  // required: return value of last curried fn
  tailFnReturnValue: 'hey!',
}

const mockCurryFn = makeMockCurryFn(options)

const {
  // to assert curried fns to be called with certain arguments
  expectMockFnsCalledWith,
  // head fn to be used as the entrypoint for the curried fn to be used
  headMockFn,
  // tail fn to be called at the end of the chained curried fns
  tailMockFn,
  // list of mock fns (chained together to work in curry scenario)
  mockFns,
  // initial options used to initialize current curryFn
  options,
} = mockCurryFn

See more: makeMockCurryFn.ts

Tips:

  • For most use cases, you will only need to use headMockFn and expectMockFnsCalledWith().
  • For other advanced cases, can access individual mockFns to modify underlying jest.fn()s to suit your scenario.
    • Eg. Asserting specific mock function not to be called with certain argument.
    • Eg. Modifying tailMockFn to return different return value depending on how the function is called.