unkit v0.1.0
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.
/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 foir 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
oryarn upgrade unkit
: This will update the lock-file with minimal risk to the latest versions. - Remove
package-lock.json
oryarn.lock
and reinstall dependencies withnpm i
oryarn
this will update all nested dependencies to the latest.