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

@egodigital/nef

v3.1.0

Published

Managed Extensibility Framework like library written for Node.js

Downloads

9

Readme

npm

NEF (Node.js Extensibility Framework)

Managed Extensibility Framework like library written for Node.js 10+, in TypeScript.

Install

Execute the following command from your project folder, where your package.json file is stored:

npm install --save @egodigital/nef

Usage

Build

# install modules
npm install

# build
npm run build

Requirements

TypeScript

You have to enable decorator feature in your tsconfig.json file:

{
    "compilerOptions": {
        // ...

        "experimentalDecorators": true
    },
    
    // ...
}

Examples

Quick start
Exports

First define a service and a contract:

import { Export } from '@egodigital/nef';

interface IMyService {
    foo(): string;
}

@Export('IMyService') // we have to use a string here, because in TypeScript, Interfaces are virtual and no objects
export class MyService implements IMyService {
    public foo() {
        return 'bar';
    }
}

In that example MyService is the implemented service of IMyService contract.

Imports

Now, implement a class, which gets an instance, exported with IMyService contract, as injected object:

import { Import } from '@egodigital/nef';

export class MyContext {
    @Import('IMyService')
    public service: IMyService;
}
Injections

At the end, the thing, which collects all exports and injects them into object properties, marked with @Import decorators, is an CompositionContainer instance:

import { CompositionContainer } from '@egodigital/nef';

let context = new MyContext();

let container = new CompositionContainer();
container.addClasses(MyService);  // tell explicitly, that 'MyService' is
                                  // a class with an '@Export' decorator

container.composeSync(context);
// now 'context.service' should
// hold an instance of 'MyService' class
// managed by 'container'

Catalogs

Catalogs helps to detect classes, which should be exported as services.

ApplicationCatalog

A catalog based on one or more JavaScript modules one application.

import { ApplicationCatalog, CompositionContainer } from '@egodigital/nef';

let container = new CompositionContainer();
container.addCatalogs(
    new ApplicationCatalog(process)  // add current application
);

// shorter:
// container.addApplications(process);

ClassCatalog

A catalog for a single class.

import { ClassCatalog, CompositionContainer, Export } from '@egodigital/nef';

@Export()
class MyService {
}

let container = new CompositionContainer();
container.addCatalogs(
    new ClassCatalog(MyService)
);

// shorter:
// container.addClasses(MyService);

DirectoryCatalog

A catalog based on one or more JavaScript modules in a directory.

import { CompositionContainer, DirectoryCatalog } from '@egodigital/nef';

let container = new CompositionContainer();
container.addCatalogs(
    new DirectoryCatalog('/path/to/directory')
);

// shorter:
// container.addDirectories('/path/to/directory');

FileCatalog

A catalog based on one or more JavaScript modules in a single file.

import { CompositionContainer, FileCatalog } from '@egodigital/nef';

let container = new CompositionContainer();
container.addCatalogs(
    new FileCatalog('/path/to/file.js')
);

// shorter:
// container.addFiles('/path/to/file.js');

ModuleCatalog

A catalog for a JavaScript module.

import { CompositionContainer, ModuleCatalog } from '@egodigital/nef';
const myModule = require('my-module');

let container = new CompositionContainer();
container.addCatalogs(
    new ModuleCatalog(myModule)
);

// shorter:
// container.addModules(myModule);

Documentation

The API documentation can be found here.