cfn-template-stream's Introduction

cfn-template-stream

Streamingly read/parse/stringify CloudFormation templates

Install

$ npm install --save cfn-template-stream

Usage

var cfnTemplate = require('cfn-template-stream')

cfnTemplate.fromFile('./my-template.yml')
  .pipe(ObjectTransform())
  .pipe(cfnTemplate.Stringify('.yml'))
  .pipe(fs.createWriteStream('./my-template-transformed.yml'))

API

`template.Parse(extension)` -> `stream.Transform`

Returns a transform stream that receives template strings in the specified format and emits parsed template objects.

extension

Required
Type: string

The file extension, either .json or .yml.

`template.fromFile(filename)` -> `stream.Readable`

Returns a readable stream that auto-detects the file type from the filename and pipes the data to template.Parse.

filename

Required
Type: string

The path to a .json or .yml file.

`template.Stringify(extension)` -> `stream.Transform`

Returns a transform stream that receives template object chunks and emits template strings.

extension

Required
Type: string

The file extension, either .json or .yml.

License

MIT © Ben Drucker

cfn-template-stream's People

Contributors

Stargazers

Watchers

cfn-template-stream's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

bendrucker / cfn-template-stream Goto Github PK

cfn-template-stream's Introduction

cfn-template-stream

Install

Usage

API

template.Parse(extension) -> stream.Transform

extension

template.fromFile(filename) -> stream.Readable

filename

template.Stringify(extension) -> stream.Transform

extension

License

cfn-template-stream's People

Contributors

Stargazers

Watchers

cfn-template-stream's Issues

Recommend Projects

Recommend Topics

Recommend Org

`template.Parse(extension)` -> `stream.Transform`

`template.fromFile(filename)` -> `stream.Readable`

`template.Stringify(extension)` -> `stream.Transform`