Namable

Cross-check whether it can be used as a package name or domain name

🔖 Table of Contents

• 🔖 Table of Contents
• ✨ Features
  • Package name
• 📝 API
  • CLI
    • Deno
      • Example
    • Node.js
      • Example
• 💚 Supports
  • ES modules
  • UMD
• :handshake: Contributing
• 🌱 Show your support
• 💡 License

✨ Features

• ⚡ Multi runtime support (Deno, Node.js and Browsers)
• 📚 Pure TypeScript and provides type definition
• :earth_americas: Universal module, providing ES modules and UMD
• :package: Optimized, super slim size
• 📄 TSDoc-style comments

Package name

Deno: registerable (deno.land, nest.land)

Node.js: registerable (npm)

📝 API

CLI

The Cli interface is common to Deno and Node.js.

@runtime <name> [Options]

@runtime: How to call it depends on the runtime. See Deno or Node.js sections.

name: Check module is registerable or not. <required>

Options:
All options are optional

Deno

@runtime: deno run -allow-net https://deno.land/x/registerable/cli.ts

Example

deno run -allow-net https://deno.land/x/registerable/cli.ts <name> [Options]

Node.js

@runtime: npx registerable

Example

npx registerable <name> [Options]

💚 Supports

The TypeScript version must be 4.1.0 or higher.

This project provide ES modules and UMD. The range supported by both is different.

ES modules

Limit support to the latest environment to reduce the bundle size.

Deno	Node.js	Edge	Firefox	Chrome	Safari	iOS Safari	Samsung	Opera
^1.6.0	^14.16.0	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions

UMD

Browser is supporting since IE11.

Node.js	IE / Edge	Firefox	Chrome	Safari	iOS Safari	Samsung	Opera
^6.17.0	IE11 / ^16	^60	^61	^10.1	^10.3	^8.2	^48

Compared to ES modules, UMD has a bundle size increase of about 2.5x. Recommend using ES modules as much as possible.

:handshake: Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues.

🌱 Show your support

Give a ⭐️ if this project helped you!

💡 License

Copyright © 2021-present TomokiMiyauci.

Released under the MIT license