https://github.com/ardean/smb2

A SMB2 implementation in TypeScript
https://github.com/ardean/smb2

smb smb-client smb2

Last synced: 4 days ago
JSON representation

A SMB2 implementation in TypeScript

• Host: GitHub
• URL: https://github.com/ardean/smb2
• Owner: ardean
• License: mit
• Created: 2020-05-07T17:51:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T15:10:50.000Z (11 months ago)
• Last Synced: 2024-10-29T22:45:47.563Z (22 days ago)
• Topics: smb, smb-client, smb2
• Language: TypeScript
• Homepage:
• Size: 267 KB
• Stars: 7
• Watchers: 3
• Forks: 5
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# @stifani/smb2

> A SMB2 implementation in TypeScript.

[![Github Version](https://img.shields.io/github/release/ardean/smb2.svg)](https://github.com/ardean/smb2)

[![NPM Version](https://img.shields.io/npm/v/@stifani/smb2.svg)](https://npmjs.org/package/@stifani/smb2)

[![NPM Downloads](https://img.shields.io/npm/dm/@stifani/smb2.svg)](https://npmjs.org/package/@stifani/smb2)

[![License](https://img.shields.io/npm/l/@stifani/smb2.svg)](LICENSE.md)

## Installation

```sh

$ npm i @stifani/smb2

```

## Usage

```ts

import smb2 from "@stifani/smb2";

const client = new smb2.Client(host);

const session = await client.authenticate({

  domain,

  username,

  password

});

const tree = await session.connectTree(share);

const entries = await tree.readDirectory("/");

console.log(entries);

```

## Features

### Client

- watch shares for file and directory changes

- create, read & remove & rename files

- create, list & remove & rename directories

- check directory/file exists

## WIP

- SMB

- Server

## License

[MIT](LICENSE.md)