Registerable
Check if it can be registered as a module name or domain name
🔖 Table of Contents
- 🔖 Table of Contents
- ✨ Features
- 📝 API
- 💚 Supports
- :handshake: Contributing
- 🌱 Show your support
- 💡 License
✨ Features
- ⚡ Multi runtime support (
Deno
,Node.js
) - 📚 Pure TypeScript and provides type definition
- :earth_americas: Universal module, providing
ES modules
andUMD
- :package: Optimized, super slim size
- 📄 TSDoc-style comments
Module registry
📝 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
flag | desc | type | default | choice |
---|---|---|---|---|
-r , --registry |
Query to registry | array |
[deno.land , nest.land , npm ] |
deno.land , nest.land , npm |
-j , --json |
Display to JSON format | boolean |
false |
|
--verbose |
Verbose mode | boolean |
true |
|
-h , --help |
Show help | boolean |
||
-v , --version |
Show version number |
Deno
@runtime
: deno run --allow-net https://deno.land/x/registerable/cli.ts
Configuration
Required permissions:
- --allow-net
Local
You can use it directly from the CLI by using deno run
:
deno run --allow-net https://deno.land/x/registerable/cli.ts <name> [Options]
Global
You can also install it globally using the following:
deno install --allow-net -n registerable https://deno.land/x/registerable/cli.ts
Then, the package is available to run:
registerable <name> [Options]
Node.js
Local
You can install locally.
yarn add -D registerable
or
npm i -D registerable
then,
yarn registerable <name> [Options]
or
npm run registerable <name> [Options]
Global
You can also install it globally using the following:
yarn global add registerable
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