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

decorator-builder

v0.2.4

Published

Easily create decorators for multiple and flexible purposes

Downloads

7

Readme

Actions Status Actions Status Actions Status Test Coverage Maintainability Packages npm version

Easily create decorators for multiple and flexible purposes

How to install

npm i decorator-builder

How to use it

Just create your new decorator

const MyDecorator = createClassDecorator();

And then, apply it to your class!

@MyDecorator()
class MyClass {}

The generated decorator is also an Iterable, so, you can get access to every decorated class already loaded

for (const item of MyDecorator) {
  // Target is the Class and args the arguments informed into the decorator
  doABarrelRoll(item.target, item.args);
}

You can also create method decorators:

const MyDecorator = createMethodDecorator();
class MyClass {
  @MyDecorator()
  myMethod() {

  }
}

for (const item of MyDecorator) {
  // Target is the Prototype, name is the method name, descriptor the method descriptor, and args the arguments informed into the decorator
  doABarrelRoll(item.target, item.name, item.descriptor, item.args);
}

Property decorators:

const MyDecorator = createPropertyDecorator();
class MyClass {
  @MyDecorator()
  myProperty: string;
}

for (const item of MyDecorator) {
  // Target is the Prototype, name is the property name, and args the arguments informed into the decorator
  doABarrelRoll(item.target, item.name, item.args);
}

And parameters decorators:

const MyDecorator = createParameterDecorator();
class MyClass {
  myMethod(@MyDecorator() arg: string) {}
}

for (const item of MyDecorator) {
  // Target is the Prototype, name is the method name, index the parameter index, and args the arguments informed into the decorator
  doABarrelRoll(item.target, item.name, item.index, item.args);
}

If you want to create a decorator that receives parameters, you can inform it in it's creation through a function template:

// It works with every type of decorator
const MyDecorator = createMethodDecorator<(value: number, name: string) => void>();

You can also inform a callback to be called at every decorator appliance

const MyDecorator = createMethodDecorator((item) => {
  console.log(item.name);
})

This package also provides a helper function if you want to apply some modification into a class. This is useful to apply in the callback of the decorator:

wrapClass(item.target, (self: SomeClassExtended, a: string, b: number) => {
  self.c = a + b;
})

There is a helper function too so you can wrap methods. This function will directly replace a method on the prototype or the instance, whenever is provided:

// Replaces the method prototype
wrapMethod(SomeClass.prototype, 'method', (previousVersion, paramsOfTheMethod) => previousVersion(paramsOfTheMethod) + 2);
// Replaces just the instance method
wrapMethod(instance, 'method', (previousVersion, paramsOfTheMethod) => previousVersion(paramsOfTheMethod) + 3);

License

Licensed under MIT.