unjs / unkit

📙 UnJS standard library

unkit

UnJS standard library

This package aggregates a collection of useful packages from unjs for ease of use.

💿 Install

Install using npm or yarn:

npm i unkit
# or
yarn add unkit

Import a subpath:

// ESM / Typescript
import { pascalCase  } from 'unkit/string'

// CommonJS
const { pascalCase } = require('unkit/string')

💡 Note: Please always explicitly install unkit dependency even if it is already installed by another package in node_modules.

Check ⬆️ Upgrading Guide for upgrading versions.

📙 Libraries

Libraries are exposed via semantic subpaths. Refer to each package documentation for available utilities.

Subpath	Packages
unkit/env	unjs/std-env
unkit/esm	unjs/mlly
unkit/fetch	unjs/ohmyfetch
unkit/http	unjs/h3, unjs/is-https
unkit/object	unjs/defu, unjs/destr
unkit/promise	unjs/items-promise
unkit/string	unjs/scule
unkit/url	unjs/ufo

/env

Useful environment information of running code.

👉 See unjs/std-env for more information.

// ESM / Typescript
import {  production, dev } from 'unkit/env'

// CommonJS
const { production, dev } = require('unkit/env')

/esm

Missing ECMaScript module utils for Node.js

👉 See unjs/mlly for more information.

// ESM / Typescript
import { createCommonJS, resolve } from 'unkit/esm'

/fetch

A better fetch API. Works on node, browser, and workers

👉 See unjs/ohmyfetch for more information.

// ESM / Typescript
import { $fetch } from 'unkit/fetch'

// CommonJS
const { $fetch } = require('unkit/fetch')

/http

Helpers for creating HTTP servers

👉 See unjs/h3 and unjs/is-https for more information.

// ESM / Typescript
import { useBody, isHTTPS } from 'unkit/http'

// CommonJS
const { useBody, isHTTPS } = require('unkit/http')

/object

Utilities for working with objects and serialization

👉 See unjs/defu and unjs/destr for more information.

// ESM / Typescript
import { defaults, parseJSON } from 'unkit/object'

// CommonJS
const { defaults, parseJSON } = require('unkit/object')

/promise

Promise utils

👉 See unjs/items-promise for more information.

// ESM / Typescript
import { serial, parallel } from 'unkit/promise'

// CommonJS
const { serial, parallel } = require('unkit/promise')

/string

String manipulation utils

👉 See unjs/scule for more information.

// ESM / Typescript
import { snakeCase, upperFirst } from 'unkit/string'

// CommonJS
const { snakeCase, upperFirst } = require('unkit/string')

/url

Utilities to work with URLs

👉 See unjs/ufo for more information.

// ESM / Typescript
import { joinURL, withQuery } from 'unkit/url'

// CommonJS
const { joinURL, withQuery } = require('unkit/url')

⬆️ Upgrading

Unkit uses npm dependencies with caret range, this means when you freshly install unkit, the latest features and fixes of sub-dependencies are installed. For upgrading we have two choices:

• Use npm up unkit or yarn upgrade unkit: This will update the lock-file with minimal risk to the latest versions.
• Remove package-lock.json or yarn.lock and reinstall dependencies with npm i or yarn this will update all nested dependencies to the latest.

License

MIT

unkit's Issues

Typings for standard modules

currently all imports from unkit are untyped

Add `requrl` to `/url`

What do you think of also adding

import { getURL } from 'unkit/url'

https://github.com/unjs/requrl

Support for CLI

Describe the feature

Context

I am currently using unjs/citty to make CLI tools.
While creating CLI tools, I have been saved by many unjs stacks such as

• 🌆 unjs/citty
• 🐨 unjs/consola
• 💅 unjs/changelogen
• 📦 unjs/unbuild
• 🍟 unjs/jiti

There are others that are needed(magicast, unctx, c12, pathe, etc), but we believe the above are the minimum.
So, I would like to provide unkit for those who want to make CLI with unjs in the future.

Design

• add src/cli.ts
• add exports.cli options in package.json

Additional information

• Would you be willing to help implement this feature?

Tasks

Beta Give feedback

No tasks being tracked yet.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource	Name	Replacement PR?
npm	ohmyfetch

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency destr to v2
• chore(deps): update dependency h3 to v1
• chore(deps): update dependency mlly to v1
• chore(deps): update dependency scule to v1
• chore(deps): update dependency ufo to v1
• chore(deps): update devdependency unbuild to v2
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v3
• actions/setup-node v3

npm

package.json

• defu ^6.1.4
• destr ^1.2.2
• h3 ^0.8.6
• is-https ^4.0.0
• items-promise ^1.0.0
• mlly ^0.5.17
• ohmyfetch ^0.4.21
• requrl ^3.0.2
• scule ^0.3.2
• std-env ^3.7.0
• ufo ^0.8.6
• unbuild ^1.2.1

---

• Check this box to trigger a request for Renovate to run again on this repository