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

hefty

v2.0.0

Published

Easy, unopinionated and intuitive Typescript fixtures.

Downloads

144

Readme

Hefty

Easy, unopinionated and intuitive Typescript fixtures.

Installation

npm install hefty --save-dev

Usage

Hefty lets you create factories, chain multiple states and override those states too. Check out the tests for more examples.

Create a Factory

Factories are made up of entities with one or more states applied to them. States are called with the same params you get with Array.map().

// User.ts
class User {
  email: string
  emailConfirmed: boolean
  onboarded: boolean
}

// UserFactory.ts
import { Factory } from 'hefty'

class UserFactory extends Factory<User> {
  constructor() {
    super(User)
  }

  hasConfirmed(): this {
    return this.state(() => ({
      emailConfirmed: true
    }))
  }

  hasOnboarded(): this {
    return this.state(() => ({
      onboarded: true
    }))
  }
}

Create some users

const factory = new UserFactory()

const user1: User = await factory.one()
// -> emailConfirmed = false

const user2: User = await factory.emailConfirmed().one()
// -> emailConfirmed = true

const user3: User = await factory.emailConfirmed().onboarded().one()
// -> emailConfirmed = true, onboarded = true

const user4: User = await factory.emailConfirmed().state(() => ({ email: [email protected] })).one()
// -> emailConfirmed = true, email = [email protected]

const users: User[] = await factory.emailConfirmed().many(3)
// -> generates 3 users with emailConfirmed = true

State functions defined in the factory and state() can be chained as many times as you like in any order. They'll all be applied sequentially when one() or many() is called.

Factories with default states

Factories can implement a definition() function that is called before any other states are applied.

export default class UserFactory extends Factory<User> {
  constructor() {
    super(User)
  }

  protected definition(): void {
    this.state(() => {
      createdAt: 'today',
      emailConfirmed: true
    })
  }

  onboarded(): this {
    return this.state(() => ({
      onboarded: true
    }))
  }

  emailConfirmed(): this {
    return this.state(() => ({
      emailConfirmed: true
    }))
  }
}

const factory = await new UserFactory().one()
// => createdAt = today, emailConfirmed: true 

Promises

Hefty will automatically resolve any promise-based state() callbacks.

export default class UserFactory extends Factory<User> {
  constructor() {
    super(User)
  }

  protected definition(): void {
    this.state(async () => ({
      password: await bcrypt.hash('password', 10)
    }))
  }
}

Constructors

You can pass constructor params to the construct() function. Entities will be initialised with these params before the definition is applied.

// User.ts
class User {
  email: string

  constructor(email: string) {
    this.email = email
  }
}

// User.test.ts
const email = '[email protected]'
expect((await new UserFactory().construct(email).one()).email).toBe(email)