@infuse/pocketknife v1.1.1

Pocketknife

(Public NPM package)
######A library for sharing various tools used in our node projects

Installation

npm install --save @infuse/pocketknife

Requirements

• node.js >= v8.10
• npm >= v6.4

Development

1. Add new modules to the src folder
2. Add any package dependencies through package.json
3. Export the module through the ~/index.js file

Running Locally

1. Navigate to project root
2. run npm link (will build a symlink to @infuse/pocketknife)
3. Navigate to root of project that requires pocketknife
4. run npm link @infuse/pocketknife
5. Verify that updated pocketknife has been inserted into project's node_modules

Publishing

1. Bump up the package.json version using semver rules (https://semver.org/)
2. Run npm publish --access public

TODO

• Add tests
• Add linting
• Add CI/publishing on every merge to master

Modules

Emailer

• Description - Module facilitating the sending of emails
• Methods - sendEmail
• ENV Variables - MAILER_ADDRESS: server host - MAILER_USER: server user - MAILER_PASSWORD: server password - MAILER_SENDER: sender email address - EMAILS: recipient email addresses

Logger

• Description - Module facilitating console and logentries logging
• Methods - logInfo - logError
• ENV Variables - LOGENTRIES_TOKEN: api key mapping to logentries project - LOGENTRIES_REGION (optional): region where logentries project was set up (defaults to eu)

S3

• Description - Module facilitating s3 access/object retrieval
• Methods - getObjectFromS3 - getFileAndDirectoryFromKey

SFTP

• Description - Module facilitating file upload to SFTP servers
• Methods - uploadFileOnSftpServer