websocket-sftp

library0.8.4jsnpmunverified

WebSocket-SFTP implements the SFTP protocol over WebSocket connections. Version 0.8.4 is current; development appears to be ongoing but with small community. Key differentiator: enables SFTP in browser environments where raw TCP is unavailable. Provides both client and server implementations with full TypeScript types. Important for projects needing file transfer over WebSockets, commonly used alongside websocketfs infrastructure.

storage

npm install websocket-sftp

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · WEBSOCKET-SFTP

websocket-sftp

storagejavascriptv0.8.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

WebSocketSFTPClient

✓ import { WebSocketSFTPClient } from 'websocket-sftp'

✗ const WebSocketSFTPClient = require('websocket-sftp').WebSocketSFTPClient

Package ships ESM-only; CJS require requires .default or destructuring

WebSocketSFTPServer

✓ import { WebSocketSFTPServer } from 'websocket-sftp'

✗ import WebSocketSFTPServer from 'websocket-sftp'

Named export, not default

SFTPStream

✓ import { SFTPStream } from 'websocket-sftp'

✗ import { Stream } from 'websocket-sftp'

Class is SFTPStream, not Stream

Shows how to create a WebSocket SFTP client, connect, and list a directory.

import { WebSocketSFTPClient } from 'websocket-sftp'; import WebSocket from 'ws'; const ws = new WebSocket('wss://example.com/sftp'); const client = new WebSocketSFTPClient(ws); client.on('ready', () => { client.readdir('/', (err, list) => { if (err) throw err; console.log('Directory:', list); client.end(); }); }); client.on('error', (err) => console.error(err));

Debug

Known issues

gotchaThe library requires a WebSocket library (like 'ws') in Node.js; browser environment provides native WebSocket.

fix

Ensure WebSocket is provided either by environment or via 'ws' package.

affects: >=0.0.0

breakingVersion 0.8.0 changed export structure from default to named exports.

fix

Update imports: `import { WebSocketSFTPClient } from 'websocket-sftp'` instead of `import WebSocketSFTPClient from 'websocket-sftp'`.

affects: >=0.8.0

deprecatedThe `SFTPWrapper` class is deprecated in favor of `SFTPStream`.

fix

Replace `SFTPWrapper` with `SFTPStream` in code.

affects: >=0.7.0

gotchaThe library does not handle WebSocket reconnection automatically; developers must implement reconnection logic.

fix

Use a WebSocket wrapper that supports reconnection (e.g., 'reconnecting-websocket').

affects: >=0.0.0

Errors

Common errors & fixes

TypeError: WebSocketSFTPClient is not a constructor

Using default import when package exports named exports.

fix

Use named import: `import { WebSocketSFTPClient } from 'websocket-sftp'`

Error: WebSocket is not defined

Running in Node.js without providing a WebSocket implementation.

fix

Install 'ws' and provide a WebSocket object: `import WebSocket from 'ws'`

Module not found: Can't resolve 'websocket-sftp'

Package not installed or not in node_modules.

fix

Run `npm install websocket-sftp`

Upgrade

Version history

0.8.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

39 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/sagemathinc/websocketfs ↗

packagewebsocket-sftp ↗

homepagehttps://github.com/sagemathinc/websocketfs#readme ↗