Giter Club home page Giter Club logo

team-igniter-from-houston-inc / async-fn Goto Github PK

View Code? Open in Web Editor NEW
10.0 3.0 3.0 1.98 MB

Additional methods for different mocking libraries to introduce "late resolve" of promises returned by the mock functions. This allows tests that read chronologically, like a story.

Home Page: https://medium.com/houston-io/how-to-unit-test-asynchronous-code-for-javascript-in-2020-41c124be2552

JavaScript 99.35% Shell 0.65%
javascript jest sinon async async-await unit-testing tdd bdd

async-fn's Introduction

asyncFn

Build and test Gitter

asyncFn

asyncFn is a library that provides additional methods to jest.fn or sinon.spy to introduce "late resolve" for the promises returned.

This simplifies async unit testing by allowing tests that read chronologically, like a story.

asyncFn has zero non-native dependencies. It has 100% unit test coverage, and 3+ years of focused production use with high developer satisfaction.

asyncFn is also integration-tested for combinations of recent OS-, node- and mocking framework -versions.

How to install

$ npm install --save-dev @async-fn/jest

or

$ npm install --save-dev @async-fn/sinon

See more details for jest or sinon.

Tutorial

See tutorial here.

Examples

See examples for jest or sinon.

Who are we?

asyncFn is lovingly crafted by Your pals at Team: Igniter from Houston Inc. Consulting.

We are a software development team of friends, with proven tradition in professional excellence. We specialize in holistic rapid deployments without sacrificing quality.

Come say hi at Gitter, email us, or check out the team's website. We just might be open to hiring ;)

async-fn's People

Contributors

dependabot[bot] avatar ifwu avatar iku-turso avatar jansav avatar nokel81 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

ifwu jansav nokel81

async-fn's Issues

TypeScript Definitions

Currently, there are no TypeScript definition files in the package. Is possible to export them?
My global definition for the '@async-fn/jest' package is below:

/// <reference types="jest" />

type AsyncFunction = (...args: any[]) => Promise<unknown>;

type PromiseValue<PromiseType, Otherwise = PromiseType> = PromiseType extends Promise<infer Value>
	? { 0: PromiseValue<Value>; 1: Value }[PromiseType extends Promise<unknown> ? 0 : 1]
	: Otherwise;

type AsyncReturnType<Target extends AsyncFunction> = PromiseValue<ReturnType<Target>>;

declare module '@async-fn/jest' {
  type MockedAsyncFn<T extends (...args: any[]) => any> =
    & Omit<
      jest.MockInstance<ReturnType<T>, Parameters<T>>,
      | 'mockImplementation'
      | 'mockImplementationOnce'
      | 'mockReturnValue'
      | 'mockReturnValueOnce'
    >
    & T & {
      resolve: (resolvedValue: AsyncReturnType<T>) => Promise<void>,
      reject: (rejectValue: any) => Promise<void>
    };
  export type { MockedAsyncFn };

  export default function asyncFn<T, Y extends any[]>(implementation?: (...args: Y) => T): jest.Mock<T, Y>;
  export default function asyncFn(): jest.Mock;
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.