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

ts-mox

v1.0.2

Published

A module to provide a way to create actual mocks of objects like in Java.

Downloads

17

Readme

ts-mox

Installation

To install this, run

npm install --save-dev ts-mox

// or alternatively

yarn add -D ts-mox

Why

When I was programming in Java, thanks to dependency injection, we could easily unit test classes by passing mock dependencies to their constructors. I use dependency injection in typescript too, with the typescript-ioc library. The problem is, there is no easy way to create mocks like you can in Java without writing a lot of boiler plate code, so that's why I created ts-mox. The idea is that you can easily create an objet with the correct type, that has all the functions and properties of the class, except all the functions return null by default and the properties are null by default (you can just reassign these according to your needs).

Docs

Currently the only feature available is to create a mock instance of a class.

// Assume we have a class like this
class Foo {

    constructor() {
    }

    public fooAction(): string {
        return "fooAction";
    }
}

// Another class that has a Foo dependency
class Bar {

    constructor(@Inject private foo:Foo) {
    }

    public barAction(): object {
        return {
            property: this.foo.fooAction();
        }
    }
}

// When we want to unit test Bar, we can easily do

describe('Bar', () => {
    let foo:Foo;
    let classUnderTest:Bar;

    beforeEach(() => {
        foo:Foo = Mox.createMock<Foo>(Foo);
        classUnderTest = new Bar(foo);
    });

    describe('barAction', () => {
        
        it('should return an object with property', () => {
            const mockReturn = "someMockReturn";
            foo.fooAction = () => mockReturn; 

            const actual = classUnderTest.barAction();
            expect(actual.property).to.equal(mockReturn);
        });

        // If you want to do some verifies or stuff with sinon, you can do this too:

        it('should return an object with property', () => {
            const mockReturn = "someMockReturn";
            const fooMock = sinon.mock(foo);
            fooMock.expects("fooAction").returns(mockReturn);
            const actual = classUnderTest.barAction();
            fooMock.verify();
            expect(actual.property).to.equal(mockReturn);
        });
    });

});

Feel free to do pull requests or ask for more features.