An open API service indexing awesome lists of open source software.

https://github.com/andreialecu/dpd-codemodule

This custom resource type allows you to write code that can be required by other resources.
https://github.com/andreialecu/dpd-codemodule

deployd

Last synced: 29 days ago
JSON representation

This custom resource type allows you to write code that can be required by other resources.

Awesome Lists containing this project

README

          

## Code Resource for deployd

[![Current Version](https://img.shields.io/npm/v/dpd-codemodule.svg?style=flat-square)](https://www.npmjs.org/package/dpd-codemodule)

This is a custom [deployd](https://www.npmjs.org/package/deployd) resource type allows you to write code that can be `require`d by other resources.

### Installation

In your app's root directory, type `npm install dpd-codemodule --save` into the command line or [download the source](https://github.com/deployd/dpd-codemodule). This should create a `dpd-codemodule` directory in your app's `node_modules` directory.

See [Installing Modules](http://docs.deployd.com/docs/using-modules/installing-modules.md) for details.

### Usage

You can write your reusable code inside the `Index` event. Follow `nodejs` module conventions by using `exports.somename = ...;`. See nodejs [modules](https://nodejs.org/api/modules.html) documentation for more details.

Later on in your event code, you can use:

`var myCodeModule = requireModule('coderesourcename');` and you will have access to the code shared by the module.

This resource explicitly adds the `requireModule(name)` global function which acts as a helper function for finding the proper path of the module.

Alternatively, you can use something like `require('../../resources/coderesourcename')`.