gersemi

Using this module in other modules

Here is a quick example of how this module can be used in other modules. The TypeScript Module Resolution Logic makes it quite easy. The file src/index.ts is a barrel that re-exports selected exports from other files. The package.json file contains main attribute that points to the generated lib/index.js file and typings attribute that points to the generated lib/index.d.ts file.

If you are planning to have code in multiple files (which is quite natural for a NodeJS module) that users can import, make sure you update src/index.ts file appropriately.

Once published to npm with the name gersemi, this module can be installed in the module in which you need it -

• To use the GenesisBase class in a TypeScript file -

import { GenesisBase } from "gersemi";

const service = GenesisBase.extend({ url: '/some-url' });
service().then((res) => {
    console.log('Success!', res);
});

• To use the GenesisBase class in a JavaScript file -

const GenesisBase = require('gersemi').GenesisBase;

const service = GenesisBase.extend({ url: '/some-url' });
service().then((res) => {
    console.log('Success!', res);
});

Release History

• 2017-10 v0.0.3 (development)