Skip to content

Latest commit

 

History

History
 
 

cfn2ts

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

cfn-to-ts

Generates TypeScript classes for all CloudFormation resource and property types.

Usage:

$ cfn-to-ts <typescript-output-path> [enrichments-dir]

The CloudFormation spec is built-into this package (at the moment).

The command will read the CloudFormation Spec and will create a single .ts file that contains types for all resources and property types.

If enrichments-dir is specified, the tool will look for .ts files under that directory named after CloudFormation full type names. If it founds, those types will be generated with a XxxBase postfix, and the code inside the enrichments directory will be included in the generated output. This allows "extending" CloudFormation types with additional capabilities.

The library exports the following API:

async function(outputFilePath: string, enrichmentsDir?: string)

For example:

import generate from 'aws-cfn-to-ts'
generate('cfn.ts', 'enrichments/').then(() => console.log('done'));