Windows UNC Path Connect for Node

Ensures a UNC path that requires a user name and password is ready to use in Windows before use.

Installation

npm install @cityssm/windows-unc-path-connect

Usage

import { connectToUncPath } from '@cityssm/windows-unc-path-connect'

const uncPath = '\\\\server\\fileShare'

/*
 * Connect to share
 */

const success = connectToUncPath(
  {
    uncPath,
    userName: 'user',
    password: 'p@ss'
  },
  {
    // Optionally attempt to clean up connection on application shutdown.
    deleteOnExit: true,

    // Optionally assign a drive letter.
    driveLetter: 'M:',

    // Optionally persist the connection after restart.
    persistent: true
  }
)

/*
 * Reading files should now work.
 */

try {
  const files = await fs.readdir(uncPath)
} catch (error) {}