@types/ssh2-streams

What is @types/ssh2-streams?

@types/ssh2-streams provides TypeScript definitions for the ssh2-streams library, which is used for parsing and generating SSH2 protocol streams. This package is essential for developers who want to use ssh2-streams in a TypeScript environment, ensuring type safety and better development experience.

What are @types/ssh2-streams's main functionalities?

Creating an SSH2 Stream

This feature allows you to create an SSH2 stream and handle data events. The code sample demonstrates how to create an SSH2 stream, listen for data events, and write data to the stream.

const { SSH2Stream } = require('ssh2-streams');
const sshStream = new SSH2Stream();
sshStream.on('data', (data) => {
  console.log('Data received:', data);
});
sshStream.write('Hello SSH');

Parsing SSH2 Packets

This feature allows you to parse SSH2 packets. The code sample shows how to create an SSH2 stream, listen for packet events, and write packet data to the stream.

const { SSH2Stream } = require('ssh2-streams');
const sshStream = new SSH2Stream();
sshStream.on('packet', (packet) => {
  console.log('Packet received:', packet);
});
sshStream.write('Some SSH packet data');

Generating SSH2 Packets

This feature allows you to generate SSH2 packets. The code sample demonstrates how to create an SSH2 stream and generate a packet from given data.

const { SSH2Stream } = require('ssh2-streams');
const sshStream = new SSH2Stream();
const packet = sshStream.packetWrite('Some SSH packet data');
console.log('Generated packet:', packet);

Other packages similar to @types/ssh2-streams

ssh2

The ssh2 package provides a client and server implementation of the SSH2 protocol. It is built on top of ssh2-streams and offers higher-level abstractions for SSH connections, including SFTP and exec commands. Compared to @types/ssh2-streams, ssh2 is more feature-rich and user-friendly for common SSH tasks.

node-ssh

node-ssh is a higher-level library for SSH connections that wraps around ssh2. It simplifies the process of connecting to SSH servers, executing commands, and transferring files. While @types/ssh2-streams focuses on low-level SSH2 protocol streams, node-ssh provides a more straightforward API for common SSH operations.

ssh2-sftp-client

ssh2-sftp-client is a wrapper around the SFTP functionality of the ssh2 package. It provides a simplified API for interacting with SFTP servers, including file upload, download, and directory operations. This package is more specialized compared to @types/ssh2-streams, focusing specifically on SFTP operations.

README

Installation

npm install --save @types/ssh2-streams

Summary

This package contains type definitions for ssh2-streams (https://github.com/mscdex/ssh2-streams).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ssh2-streams.

Additional Details

• Last updated: Mon, 25 Sep 2023 13:39:06 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Ron Buckton, and Leo Toneff.