readme.md

This is an example on how to type (with TypeScript) Node.js functions that uses module.exports.

Code Structure

• *.js has the module code written in JavaScript
• *.d.ts has the module types
• *.usage.ts has the JavaScript module usage in TypeScript

Examples

reverseString

An example on how to type a module with a single function (the default one) without having the export default ... syntax on its .d.ts file.

mathOperations

An example on how to type a module with multiple functions.

readme.pt-br.md

Esse é um exemplo em como tipar (com TypeScript) funções de Node.js que usam module.exports.

Estrutura de código

• *.js contém o código do módulo, escrito em JavaScript
• *.d.ts contém os tipos do módulo
• *.usage.ts contém o uso do módulo JavaScript em TypeScript

Exemplos

reverseString

Um exemplo de como tipar um módulo com uma única função, a padrão (default), sem ter que usar a síntaxe export default ... no arquivo .d.ts desse módulo

mathOperations

Um exemplo de como tipar um módulo com multiplas funções.

mathOperations.d.ts

export function add(x: number, y: number): number
export function subtract(x: number, y: number): number

mathOperations.js

const add = (x, y) => x + y
const subtract = (x, y) => x - y

module.exports = {
  add,
  subtract
}

mathOperations.usage.ts

import * as mathOperations from './mathOperations'

mathOperations.add(2, 2)
//=> 4

reverseString.d.ts

declare function reverseString(text: string): string

export = reverseString

reverseString.js

const reverseString = text => text.split('').reverse().join('')

module.exports = reverseString

reverseString.usage.ts

import reverseString = require('./reverseString')

reverseString('ABC')
//=> 'CBA'