wifi-share-link

Generates shareable WIFI:// link strings for WiFi credentials. 📶

Usage

npm i wifi-share-link

import { generateWifiShareLink } from "wifi-share-link";

// "WIFI:T:None;S:My Network;;"
generateWifiShareLink({
	ssid: "My Network",
});

Options

Only ssid is required.

• encryption (string | undefined): The type of encryption, such as "WEP" or "WPA". Defaults to "nopass" if not provided.
• hidden (boolean | undefined): Whether the network avoids broadcasting its SSID publicly. This indicates to your device whether to attempt a connection to a hidden network.
• password (string | undefined): Private password used to connect if there is encryption.
• ssid (string): User-displayed name of the network.

// "WIFI:T:WPA;S:My Network;P:CorrectHorseBatteryStaple;H:true;;"
generateWifiShareLink({
	encryption: "WPA",
	hidden: true,
	password: "CorrectHorseBatteryStaple",
	ssid: "My Network",
});

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md. Thanks! 💖

Contributors

Josh Goldberg ✨ 💻 🖋 📖 🤔 🚇 🚧 📆 🔧

💝 This package was templated with create-typescript-app using the Bingo framework.