unkit

UnJS standard library

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

💿 Install

Install using npm or yarn:

1npm i unkit
2# or
3yarn add unkit

Import a subpath:

1// ESM / Typescript
2import { pascalCase  } from 'unkit/string'
3
4// CommonJS
5const { 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.

1// ESM / Typescript
2import {  production, dev } from 'unkit/env'
3
4// CommonJS
5const { production, dev } = require('unkit/env')

/esm

Missing ECMaScript module utils for Node.js

👉 See unjs/mlly for more information.

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

/fetch

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

👉 See unjs/ohmyfetch for more information.

1// ESM / Typescript
2import { $fetch } from 'unkit/fetch'
3
4// CommonJS
5const { $fetch } = require('unkit/fetch')

/http

Helpers for creating HTTP servers

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

1// ESM / Typescript
2import { useBody, isHTTPS } from 'unkit/http'
3
4// CommonJS
5const { useBody, isHTTPS } = require('unkit/http')

/object

Utilities for working with objects and serialization

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

1// ESM / Typescript
2import { defaults, parseJSON } from 'unkit/object'
3
4// CommonJS
5const { defaults, parseJSON } = require('unkit/object')

/promise

Promise utils

👉 See unjs/items-promise for more information.

1// ESM / Typescript
2import { serial, parallel } from 'unkit/promise'
3
4// CommonJS
5const { serial, parallel } = require('unkit/promise')

/string

String manipulation utils

👉 See unjs/scule for more information.

1// ESM / Typescript
2import { snakeCase, upperFirst } from 'unkit/string'
3
4// CommonJS
5const { snakeCase, upperFirst } = require('unkit/string')

/url

Utilities to work with URLs

👉 See unjs/ufo for more information.

1// ESM / Typescript
2import { joinURL, withQuery } from 'unkit/url'
3
4// CommonJS
5const { 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