Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/larrybahr/windows-network-drive
Do network drive stuff on Microsoft Window in node
https://github.com/larrybahr/windows-network-drive
mount network-drive node node-js nodejs npm npm-module npm-package windows
Last synced: 6 days ago
JSON representation
Do network drive stuff on Microsoft Window in node
- Host: GitHub
- URL: https://github.com/larrybahr/windows-network-drive
- Owner: larrybahr
- License: mit
- Created: 2017-04-27T16:32:30.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T23:32:35.000Z (almost 2 years ago)
- Last Synced: 2024-10-20T10:02:32.646Z (17 days ago)
- Topics: mount, network-drive, node, node-js, nodejs, npm, npm-module, npm-package, windows
- Language: JavaScript
- Size: 303 KB
- Stars: 23
- Watchers: 1
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# windows-network-drive
Allows a user to do network drive stuff on Microsoft Windows from node js
[See release notes for breaking changes and migration info](https://github.com/larrybahr/windows-network-drive/releases)
## Installation
```bash
$ npm install windows-network-drive
```
## Features
* Mount a network drive that will persist after reboot
* Unmount a network drive
* Get a list of all network drives
* Find if a path is already mounted and get the drive letter
* Convert Unix paths to Windows friendly paths
* TypeScript types included
## Methods
All examples assume:
```javascript
let networkDrive = require('windows-network-drive');
```
### find
Finds if a path is already mounted and returns all drive letters that point to that exact path.
```typescript
find(drivePath: string): Promise<{status: boolean, driveLetter: string, path: string, statusMessage: string}[]>
```
#### Examples
```javascript
networkDrive.find("\\\\DoesExist\\Path")
.then(function (result)
{
// result === [{status: true, driveLetter: "Z", path: "\\\\DoesExist\\Path", "statusMessage": "OK"}]
});
networkDrive.find("\\\\DoesExist\\Path\\ThisFolderIsNotPartOfTheMountPath")
.then(function (driveLetter)
{
// driveLetter === []
});
networkDrive.find("\\\\DoesNOTExist\\Path")
.then(function (driveLetter)
{
// driveLetter === []
});
```
### list
List all network drives and their paths.
```typescript
list(void): Promise
```
#### Examples
```javascript
// With network drives
networkDrive.list()
.then(function (drives)
{
/*
drives = {
"F": { "status": true, "driveLetter": "F", "path": "\\\\NETWORKA\\Files", "statusMessage": "OK" },
"K": { "status": true, "driveLetter": "K", "path": "\\\\NETWORKB\\Files", "statusMessage": "OK" }
}
*/
});
// No network drives
networkDrive.list()
.then(function (drives)
{
// drives = {}
});
```
### mount
Mounts a network drive path and returns the new drive letter.
```typescript
mount(drivePath: string, driveLetter?: string, username?: string, password?: string): Promise
```
#### Examples
```javascript
networkDrive.mount("\\\\DoesExist\\Path\\Files", "F", undefined, undefined)
.then(function (driveLetter)
{
// driveLetter = "F"
});
```
### unmount
Unmounts a network drive.
```typescript
unmount(driveLetter: string): Promise
```
#### Examples
```javascript
networkDrive.unmount("F")
.then(function ()
{
// done
});
```
### pathToWindowsPath
Converts a valid file system path to a Windows friendly path.
NOTE: All methods can take in a non Windows friendly path. This is exported for user convenience.
```typescript
pathToWindowsPath(drivePath: string): Promise
```
#### Examples
```javascript
networkDrive.pathToWindowsPath("//DoesExist/Path/Files")
.then(function (windowsPath)
{
// windowsPath = \\\\DoesExist\\Path\\Files
});
```
### isWinOs
Test the current OS is Windows.
```typescript
isWinOs(void): boolean
```
#### Examples
```javascript
if (true ===networkDrive.isWinOs())
{
console.log("This is running on Windows");
}
```
## More Examples
For more examples, check out the [example](https://github.com/larrybahr/windows-network-drive/tree/master/example) folder in the GitHub repo!
## Tests
To run the test suite, first install the dependencies, then run `npm test`:
```bash
$ npm install
$ npm test
```
## Contributing
In lieu of a formal style guide, take care to maintain the existing coding style.
* Format code with VS Code, using the default "Typescript and JavaScript Language Features" formatter.
* Add unit tests for any new or changed functionality.
* Lint and test your code.
## People
Author and list of all contributors can be found in [package.json](package.json)
## License
[MIT](LICENSE)