Skip to content

A simple npm package template that uses TypeScript, pnpm, EsNext.

Notifications You must be signed in to change notification settings

kingcc/node-package-template

Repository files navigation

<package_name>

<package_description>

  <package_demo>

Install

Node.js

Install using npm or other package managers:

npm install <package_author_name>/<package_name>

Import into your Node.js project:

// CommonJS
const { <package_name> } = require("<package_author_name>/<package_name>")

// ESM
import { <package_name> } from "<package_author_name>/<package_name>"

Deno

Install using JSR:

deno add <package_author_name>/<package_name>

#or

jsr add <package_author_name>/<package_name>

Then import into your Deno project:

import { <package_name> } from "<package_author_name>/<package_name>"

Bun

Install using this command:

bun add <package_author_name>/<package_name>

Import into your Bun project:

import { <package_name> } from "<package_author_name>/<package_name>"

Browser

It's recommended to import the minified version to save bandwidth:

import { <package_name> } from "https://cdn.skypack.dev/<package_author_name>/<package_name>?min"

However, you can also import the unminified version for debugging purposes:

import { <package_name> } from "https://cdn.skypack.dev/<package_author_name>/<package_name>"

License

This project is licensed under the <package_license>.

Author

<package_author_name>


Feel free to customize this template according to the needs of your package. If your package requires more complex setup, it's good to include detailed instructions on configuration, API references, and a changelog. Always ensure that the documentation is up to date with the latest code changes.

About

A simple npm package template that uses TypeScript, pnpm, EsNext.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published