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

bf-types

v5.52.46

Published

common type definitions and constants for block-5

Downloads

176

Readme

Doc Links

Api References

How to add a new Module

Referenced Variables | Variable | Description | | Domain | Domain that the module is grouped under | | Module | Name of the new Module | | ModuleFolder | Folder in which the module is defined |

  • Add a the ModuleFolder to src/core/domains/{domain}/{module}
    • If domain is core just use src/core/{module}
    • UpperCamel cased
  • Add export * from './{ModuleFolder}'; to the parent index for the domain
  • in src/core/DomainInfo.ts
    • Add your module name to {Domain}_MODULES in UPPER_SNAKE

ModuleFolder structure

  • {Module}.ts
    • UpperCamel Cased
    • export const {Module}Properties of type ModuleProperty[]
    • export interface I{Module} with all module property docs
  • index.ts
    • Exports * from './{Module}.ts'

How to Add a New Module Property

Note When you see ${ModuleProperty} ${MODULE_PROPERTY} ${module_property} or ${moduleProperty} replace with the module property name in the same case(Upper/Lower Camel/Snake)

add a ModuleProperty Folder src/core/ModuleProperties/${ModuleProperty} add files in that folder ${ModulePropeerty}.ts and index.ts

In ${ModulePropeerty}.ts Define your Types and commands Your commands should extend IModulePropertyCommandDTO your type your events should extend IModulePropertyEventDTO

also add a type of ${ModuleProperty}Doc which is the type that the field will be in the documents

in index.ts

export * from './${ModuleProperty}';

in 'src/core/ModuleProperties/ModuleProperties.ts'

// Add to top section
export * from './${ModuleProperty}';

// Add to this
export const ModuleProperty = Object.freeze({
   ${MODULE_PROPERTY} : '${module_property}'
}

Then add it to any modules that should have it