sails-generate-controller-ts

This is a generator for sails controllers that use TypeScript.

It is currently intended to work with the TypeScript 1.5 alpha, and the TypeScript Definition manager.

Instead of generating a Controller.js within your /api/controllers/ folder, it generates a Controller.ts instead.

I'm choosing to jump in at TypeScript 1.5 instead of earlier because of its wider implementation of ES6 syntax. (The implementation of which is still incomplete, but enough to get started with.)

If you want a way of getting started with using TypeScript in your sails project, please refer to my Getting Started post.

Installation

Certain generators are installed by default in Sails, but they can be overridden. Check the Sails docs for information on installing generator overrides / custom generators.

In order to use a generator you will need the latest Sails, ~0.11, which can be installed with:

$ npm install sails -g

Once that's all set, install the generator:

$ npm install sails-generate-controller-ts

Production Usage

On the command line

$ sails generate controller-ts

In a node script

var path = require('path');
var sailsgen = require('sails-generate');
var scope = {
	rootPath: path.resolve(__dirname)
};
sailsgen(require('sails-generate-controller-ts'), scope, function (err) {
	if (err) throw err;

	// It worked.
});

Requirements

TypeScript 1.5, alpha

npm install [email protected] -g

TypeScript Definition manager

npm install tsd -g

You can read more about an approach to using TypeScript with sails at my Getting Started post.

Questions?

See FAQ.md.

More Resources

• Stackoverflow
• #sailsjs on Freenode (IRC channel)
• Twitter
• Professional/enterprise
• Tutorials

Copyright © 2015 Lester Sy. Licensed under the terms of the MIT license.