examples.md

Examples

Here are some examples you can use as a model when writing your own type definitions.

Single function

Exposing a single function.

declare function domready (...): any;

export = domready

• https://github.com/typed-typings/npm-domready

Function with overloads.

declare function xtend <A> (a: A): A;
declare function xtend <A, B> (a: A, b: B): A & B;
export = xtend;

• https://github.com/typed-typings/npm-xtend

Utility library

Exposing a collection of utility functions and classes.

declare module JsDiff {
  class Diff {}
  function diffChars(): any;
}

export = JsDiff;

• https://github.com/typed-typings/npm-diff

Function + utility

Exposing a function, with utility methods.

declare function tape (): any;

declare namespace tape {
  export function skip (): any;
}

export = tape;

• https://github.com/typed-typings/npm-tape

Exporting class + static methods + utility (ES6)

declare class Promise <R> {
  static resolve(): Promise<void>;
}

declare module Promise {
  export interface SpreadOption {}
  export function setScheduler (): any;
}

export = Promise;

• https://github.com/typed-typings/npm-bluebird

Named export (ES6)

Export directly using ES6 semantics without a module or namespace.

export function valid(): any;

export class SemVer {}

• https://github.com/typed-typings/npm-semver