gersemi
Version:
29 lines (18 loc) • 1.6 kB
Markdown
[](https://travis-ci.org/esha/gersemi.svg?branch=master)
[](https://coveralls.io/github/esha/gersemi?branch=master)
[](http://opensource.org/licenses/MIT)
# 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](https://www.typescriptlang.org/docs/handbook/module-resolution.html) makes it quite easy. The file `src/index.ts` is a [barrel](https://basarat.gitbooks.io/typescript/content/docs/tips/barrel.html) 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 `Client` class in a TypeScript file -
```ts
import { Client } from "gersemi";
const Genesis = new Client('/some-proxy-url);
Genesis.Query.ByUserCode(12).then((res) => {
console.log('Success!', res);
});
```
### Release History
* 2018-02 [v0.1.4][] (development)
[v0.1.4]: https://github.com/esha/posterior/tree/0.1.4