Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

Latest commit

 

History

History
203 lines (134 loc) · 8.15 KB

README.md

File metadata and controls

203 lines (134 loc) · 8.15 KB

@terminal-nerds/snippets-url

package version badge dependencies badge
install size badge

➡️ This package wraps all available modules with snippets related to url — part of the terminal-nerds/snippets project.

Modules included

documentation badge

Name Size
@terminal-nerds/snippets-url/localhost localhost size gzip badge localhost size brotli badge
@terminal-nerds/snippets-url/schema schema size gzip badge schema size brotli badge
@terminal-nerds/snippets-url/social-media social-media size gzip badge social-media size brotli badge
@terminal-nerds/snippets-url/target target size gzip badge target size brotli badge

Prerequisites & usage

Optional

supported typescript version badge

If you are using typescript icon TypeScript, the latest version, which supports new features (such as satisfies), is supported.

Runtime environments

This package can be used in several runtime environments. We aim for cross-runtime compatibility and ensure proper error messages if a particular snippet cannot be run in the currently running environment.

Browsers

We use browserslist to define the minimum browsers versions supported.
Take a look at our shared browserslist configuration for more details.

Usage:

<script type="module">
	import { snippet } from "https://cdn.jsdelivr.net/npm/@terminal-nerds/snippets-url";
</script>

Bun

We aim to support the latest version of bun icon bun.

Usage:

Firstly, install it:

bun add @terminal-nerds/snippets-url

And then in a particular file:

import { snippet } from "@terminal-nerds/snippets-url";

Deno

We aim to support the latest version of deno icon Deno.

Usage:

import { snippet } from "npm:@terminal-nerds/snippets-url";

Node.js

node.js version support badge

The latest node.js icon Node.js LTS (Long-Term Support) version is the minimum one supported.

Warning
This package is written in ES Module (ESM) type.
So, if you wish to use it in a project with CommonJS (CJS) type, you need to bundle this package or a particular module(s).

Usage:

Install it first with the Node.js package manager of your choice. In our example, we use pnpm.

pnpm add @terminal-nerds/snippets-url

And then in a particular file:

import { snippet } from "@terminal-nerds/snippets-url";

Security

workflow security badge

🔐 For more information, please refer to the Security section at the root of the terminal-nerds/snippets monorepo.


License

license badge

⚖️ For more information, please refer to the License section at the root of the terminal-nerds/snippets monorepo.

Contributing

contributors badge

🤝 Contributions of any kind are welcome!

Please refer to the monorepo (terminal-nerds/snippets) project's CONTRIBUTING file for more information if you wish to get involved.

Author

🎉 The idea of this project was initiated by xeho91. However, it's the contributors who matter the most.