📃 Table of Contents

• Features
• Usage
• API
• Examples
• Changelog
• Support
• License
• Related
• Author

🤖 Features

• 💾 Detects instantly if a name is a legacy Windows device
• 🖥 Works with both file and folder names
• 🎯 Ignores case so matches are reliable
• 🧹 Handles extra spaces or extensions gracefully
• ⚡ Gives a simple true or false result for quick decisions

ℹ️ NOTE

Legacy filesystem names

When creating files or folders on Windows there are some rules about naming them, one of which is that te usage of legacy Windows devices' names as the folder/file name is prohibited, i.e.:

“Do not use the following reserved names for the name of a file:

CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and LPT9.

Also avoid these names followed immediately by an extension; for example, NUL.txt is not recommended.”.

Source: Microsoft Docs

💡 TIP

Edge-cases

Be aware that there are some edge-cases that this module also handles, examples #4 and #7 illustrate that. Technically the provided strings in those two examples are not legacy devices but you are still not allowed to create files/directories with those names.

🕵🏼 Usage

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/windev

yarn add @igorskyflyer/windev

npm i @igorskyflyer/windev

🤹🏼 API

function isWindowsDevice(name: string): boolean

Checks whether the given directory or file name is a legacy Windows device.

🗒️ Examples

import { isWindowsDevice } from '@igorskyflyer/windev'

console.log(isWindowsDevice()) // prints false
console.log(isWindowsDevice('')) // prints false
console.log(isWindowsDevice('con')) // prints true
console.log(isWindowsDevice('con.txt')) // prints true
console.log(isWindowsDevice('cOm3')) // prints true
console.log(isWindowsDevice('COM7 ')) // prints true
console.log(isWindowsDevice(' COM2 .txt.al')) // prints true
console.log(isWindowsDevice('CONnection')) // prints false

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

Licensed under the MIT license which is available here, MIT license.

💖 Support

🧬 Related

@igorskyflyer/windows-packages

💻 A Node.js module for reading the Packages registry key on Windows 10+. Useful for retrieving Windows 10+ installed Store applications. 📦

@igorskyflyer/astro-post-excerpt

⭐ An Astro component that renders post excerpts for your Astro blog - directly from your Markdown and MDX files. Astro v2+ collections are supported as well! 💎

@igorskyflyer/mapped-replacer

🗺 Zero-dependency Map and RegExp based string replacer with Unicode support. 🍁

@igorskyflyer/astro-saferesource

🎐 Adds CSP-compliant inline scripts and styles to Astro! 🎠

@igorskyflyer/pathexists

🧲 Provides ways of properly checking if a path exists inside a given array of files/directories both on Windows and UNIX-like operating systems. 🗺

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).