DefinitelyTyped/meteor

Meteor Type Definitions

These are the definitions for version 1.2.0.2 of Meteor.

Although these definitions can be downloaded separately for use, the recommended way to use these definitions in a Meteor application is by installing the typescript-libs Meteor smart package from atmosphere. The smart package contains TypeScript definitions forMeteor, common third-party libraries (e.g. jquery, underscore, d3 etc.), and common smart packages (e.g. iron-router, etc).

From within any Meteor application that is version 0.9.0 or later, install this package in the standard manner:

$ meteor add meteortypescript:typescript-libs

These definitions were generated from the from the same [Meteor data.js file] (https://github.com/meteor/meteor/blob/devel/docs/client/data.js) that is used to generate the official [Meteor docs] (http://docs.meteor.com/).

Usage (OSX/Linux)

1. Add a symbolic link to the definitions from within some directory within your project (e.g. ".typescript" or "lib"). The definitions can be found somewhere deep within <project_root_dir>/.meteor/.... The following will probably work:

    $ ln -s ../.meteor/local/build/programs/server/assets/packages/meteortypescript_typescript-libs/definitions package_defs
   

   If the definitions can't be found within the .meteor directory, you will have to manually pull down the definitions from github and add them to your project:

   https://github.com/meteor-typescript/meteor-typescript-libs

2. Install the Typescript compiler for Meteor or an IDE which can transpile TypeScript to JavaScript.

3. From the typescript files, add references. Reference the definition files with a single line:

    /// <reference path=".typescript/package_defs/all-definitions.d.ts" />  (substitute path in your project)
   

   Or you can reference definition files individually:

    /// <reference path=".typescript/package_defs/meteor.d.ts" />  (substitute path in your project)
    /// <reference path=".typescript/package_defs/underscore.d.ts" />
    /// <reference path=".typescript/package_defs/jquery.d.ts" />
   

   Meteor core definitions can be referenced in an "all-in-one" definition file ( meteor.d.ts ) or definition files specific to the locus of execution:

   - *meteor.d.ts*:  all meteor core definitions
   - *meteor.common.d.ts*:  meteor core code running on both client and server
   - *meteor.client.d.ts*:  meteor core client-only code
   - *meteor.server.d.ts*:  meteor core server-only code
   - *meteor.package.d.ts*:  meteor core package-only code
   - *meteor.build.d.ts*:  meteor core build-only code
   

   meteor.d.ts contains all of the definitions found in meteor.common.d.ts, meteor.client.d.ts, meteor.server.d.ts, meteor.package.d.ts, and meteor.build.d.ts

4. Be aware of differences in coding styles when using TypeScript (see below)

TypeScript/Meteor coding style

References

Meteor code can run on the client and the server, for this reason you should try to stay away from referencing file.ts directly: you may get unexpected results.

Rather generate a file.d.ts using tsc --declaration file.ts, and reference it in your file.

Compilation will be much faster and code will be cleaner - it's always better to split definition from implementation anyways.

Templates

With the exception of the body and head templates, Meteor's Template dot notation cannot be used (ie. Template.mytemplate). Thanks to Typescript static typing checks, you will need to use the bracket notation to access the Template.

Template['myTemplateName'].helpers({
  foo: function () {
    return Session.get("foo");
  }
});

Template['myTemplateName'].onRendered(function ( ) { ... });

Form fields

Form fields typically need to be cast to <HTMLInputElement>. For instance to read a form field value, use (<HTMLInputElement>evt.target).value.

Global variables

Preface any global variable declarations with a TypeScript "declare var" statement (or place the statement in a definition file):

declare var NavbarHelpers;
NavbarHelpers = {};
NavbarHelpers.someMethod = function() {...}

Collections

The majority of extra work required to use TypeScript with Meteor is creating and maintaining the collection interfaces. However, doing so also provides the additional benefit of succinctly documenting collection schema definitions (that are actually enforced).

To define collections, you will need to create an interface representing the collection and then declare a Collection type variable with that interface type (as a generic):

interface JobDAO {
  _id?: string;
  name: string;
  status?: string;
  queuedAt?: string;
}

declare var Jobs: Mongo.Collection<JobDAO>;
Jobs = new Mongo.Collection<JobDAO>('jobs');

Finally, any TypeScript file using collections will need to contain a reference at the top pointing to the collection definitions:

/// <reference path=".typescript/package_defs/meteor.d.ts"/>
/// <reference path=".typescript/custom_defs/collections.ts"/>

Creating definition files

Here is a guide to creating definitions: http://www.typescriptlang.org/Handbook#writing-dts-files

If you have lots of custom definitions for a project, you can:

• Create multiple definition files and include individual references to each definition file.

• Create one huge monolithic definition file so you only have to refer to that file.

• Create multiple definition files, and create a definition file with references to the other definitions files so that you only have to maintain one reference for all of you custom definitions. e.g. contents of ".typescript/custom_defs/custom-definitions.d.ts":

    /// <reference path='collections.ts' />
    /// <reference path='paraview_helpers.d.ts'/>
    /// <reference path='handsontable.d.ts'/>
    /// <reference path='utility_helpers.ts'/>
  

Transpiling TypeScript

Meteor plugin

One solution for transpiling typescript is to install the following meteor package: https://github.com/meteor-typescript/meteor-typescript-compiler

IDE/Editor Transpilation

WebStorm, SublimeText, Atom, and VisualStudio all support TypeScript. They can automatically transpile your TypeScript code into JavaScript every time you save a file.

WebStorm

To support TypeScript in WebStorm on OSX, first install the TypeScript transpiler on your system:

$ [sudo -H] npm install -g typescript

On version 10 of WebStorm or later, got to Preferences -> Languages & Frameworks -> TypeScript and check "Enable TypeScript Compiler"

On older versions of WebStorm (9 or earlier), go to Preferences -> File Watchers -> "+" symbol and add TypeScript.

SublimeText, Atom, and VisualStudio

Please refer to the documentation for these editors.

Command line

The last option is to compile code from the command line. With node and the TypeScript compiler installed:

$ tsc *.ts