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

@stewartmcgown/ts-builder

v1.3.2

Published

![npm](https://img.shields.io/npm/dw/@stewartmcgown/ts-builder) > ### A simple Typescript builder pattern for your project

Downloads

8

Readme

Typescript Logo Small Builder

npm

A simple Typescript builder pattern for your project

Usage

import { build } from '@stewartmcgown/ts-builder';

class Cthulu {
    dread: boolean;
    stats: {
        cultists: number;
        kills: number;
    }
}

const cthulu = build(Cthulu)
    .dread(true)
    .stats(b => b
        .cultists(1000)
        .kills(1000000)
    )
    .$build()

// console.log(cthulu)

[class Cthulu] {
    dread: true,
    stats: {
        cultists: 1000,
        kills: 1000000
    }
}

Nested Objects

You can either build nested objects using a builder, or by passing in an object.

const cthulu = build(Cthulu)
    .dread(true)
    .stats({
        cultists: 1000,
        kills: 1000000
    })
    .$build()

Interfaces

interface Shadow {
    innsmouth: Date;
    water: boolean;
}

const obj = build<Shadow>()
    .innsmouth(new Date())
    .water(() => !!checkWaterIsWet()) // Use functions to set plain values
    .$build();

Auto Class Hydration

ts-builder can detect if you are using a class meta framework, like @nestjs/graphql, and will hydrate entities it meets with the builder automatically.

@ObjectType()
export class A {
    @Field()
    b: B
}

@ObjectType()
export class B {
    @Field()
    c: string

    @Field()
    d: D
}

@ObjectType()
export class D {
    @Field()
    e: string
}

const a = build(A) // No additional config required
    .b(b => b
        .c('Hello World')
        .d(d => d
            .e('Hello World')
        )
    )
    .$build();

a.b.constructor === B // ✅ 
a.b.d.constructor === D // ✅ 

If you are using a

API

$build

Builds the object and returns it.

$set

Sets a property on the object.

build(Cthulu)
    .$set('dread', false) // It's his day off
    
    .$build();

You may also shallow merge objects using $set. Uses Object.assign.

build(Cthulu)
    .$set({
        stats: {
            cultists: 1000,
            kills: 1000000
        }
    })

⚠️ Function Props

If you are using a function prop, you must use $set to set it. This is because the builder needs to know that you are setting a function, and not a builder.

class Service {
    getSomething: () => Promise<string>;
}

// This will not work the way you want it to
❌ build(Service)
    .getSomething(() => fetch('...')) 

// This will work
✅ build(Service)
    .$set('getSomething', () => fetch('...')) 

// This will also work, but looks a touch ugly
✅ build(Service) 
    .getSomething(() => () => fetch('...'))