Socket
Socket
Sign inDemoInstall

@types/node

Package Overview
Dependencies
0
Maintainers
1
Versions
1842
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @types/node

TypeScript definitions for node


Version published
Weekly downloads
103M
decreased by-1.54%
Maintainers
1
Created
Weekly downloads
 

Package description

What is @types/node?

The @types/node package contains TypeScript type definitions for Node.js. It provides TypeScript interfaces and types for Node.js modules, allowing developers to use TypeScript's static type checking with the Node.js runtime environment. This helps to catch errors at compile time and provides better editor support with features like auto-completion and inline documentation.

What are @types/node's main functionalities?

File System

Type definitions for the File System module allow developers to work with the file system using TypeScript, with methods for reading, writing, and manipulating the file system.

import * as fs from 'fs';

fs.readFile('/path/to/file', 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

HTTP Server

Type definitions for the HTTP module enable developers to create HTTP servers and clients with TypeScript, handling requests and responses with proper type annotations.

import * as http from 'http';

const server = http.createServer((req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World\n');
});

server.listen(3000);

Events

Type definitions for the Events module provide types for event handling, allowing developers to work with event emitters and listeners in a type-safe manner.

import { EventEmitter } from 'events';

const eventEmitter = new EventEmitter();

eventEmitter.on('myEvent', (arg) => {
  console.log(`Event fired with argument: ${arg}`);
});

eventEmitter.emit('myEvent', 'Hello Event!');

Streams

Type definitions for the Streams module help developers to work with Node.js streams, providing types for readable, writable, duplex, and transform streams.

import * as fs from 'fs';
import * as stream from 'stream';

const readStream = fs.createReadStream('/path/to/file');
const writeStream = fs.createWriteStream('/path/to/destination');

readStream.pipe(new stream.Transform({
  transform(chunk, encoding, callback) {
    // Transform the chunk to uppercase
    callback(null, chunk.toString().toUpperCase());
  }
})).pipe(writeStream);

Child Processes

Type definitions for the Child Processes module allow developers to spawn or execute new processes, providing types for handling the output and errors.

import { exec } from 'child_process';

exec('ls -lh /usr', (error, stdout, stderr) => {
  if (error) {
    console.error(`exec error: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.error(`stderr: ${stderr}`);
});

Other packages similar to @types/node

Readme

Source

Installation

npm install --save @types/node

Summary

This package contains type definitions for node (https://nodejs.org/).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.

Additional Details

  • Last updated: Wed, 19 Jun 2024 16:07:46 GMT
  • Dependencies: undici-types

Credits

These definitions were written by Microsoft TypeScript, Alberto Schiabel, Alvis HT Tang, Andrew Makarov, Benjamin Toueg, Chigozirim C., David Junger, Deividas Bakanas, Eugene Y. Q. Shen, Hannes Magnusson, Huw, Kelvin Jin, Klaus Meinhardt, Lishude, Mariusz Wiktorczyk, Mohsen Azimi, Nikita Galkin, Parambir Singh, Sebastian Silbermann, Thomas den Hollander, Wilco Bakker, wwwy3y3, Samuel Ainsworth, Kyle Uehlein, Thanik Bhongbhibhat, Marcin Kopacz, Trivikram Kamat, Junxiao Shi, Ilia Baryshnikov, ExE Boss, Piotr Błażejewicz, Anna Henningsen, Victor Perin, Yongsheng Zhang, NodeJS Contributors, Linus Unnebäck, wafuwafu13, Matteo Collina, and Dmitry Semigradsky.

FAQs

Last updated on 19 Jun 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc