0.3.1 ā€¢ Published 1 year ago

@terminal-nerds/snippets-type v0.3.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@terminal-nerds/snippets-type

package version badgedependencies badge]dependencies url\ install size badge

āž”ļø This package wraps all available modules with snippets related to type ā€” part of the terminal-nerds/snippets project.

Modules included

documentation badge

NameSize
@terminal-nerds/snippets-type/built-inbuilt-in size gzip badge built-in size brotli badge
@terminal-nerds/snippets-type/constructorconstructor size gzip badge constructor size brotli badge
@terminal-nerds/snippets-type/non-primitivenon-primitive size gzip badge non-primitive size brotli badge
@terminal-nerds/snippets-type/primitiveprimitive size gzip badge primitive size brotli badge

Prerequisites & usage

Optional

supported typescript version badge types badge

If you are using typescript icon, 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-type";
</script>

Bun

We aim to support the latest version of bun icon.

Usage:

Firstly, install it:

bun add @terminal-nerds/snippets-type

And then in a particular file:

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

Deno

We aim to support the latest version of deno icon.

Usage:

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

Node.js

node.js version support badge

The latest node.js icon 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-type

And then in a particular file:

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

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.