\n\n \n\n## Features\n\n- TypeScript friendly\n- Fully tree-shakeable\n- No dependencies\n\n## Installation\n\nInstall `@hypernym/utils` package:\n\n```sh\n# via pnpm\npnpm add @hypernym/utils\n```\n\n```sh\n# via npm\nnpm install @hypernym/utils\n```\n\n### CDN\n\nHere are some examples of how to integrate **Hyperutils** from a CDN via a script tag.\n\nAlso, it is possible to download files manually and serve them accordingly.\n\n#### ESM (minified)\n\n```html\n\n```\n\n#### IIFE (minified)\n\n```html\n\n\n```\n\n#### UMD (minified)\n\n```html\n\n\n```\n\n## Usage\n\nAfter installation, import `utils` into your project:\n\n```ts\n// ESM & TS\nimport { isNull, isString, ... } from '@hypernym/utils'\n\n// ESM & TS\nimport { exists, copy, ... } from '@hypernym/utils/fs'\n\n// Types\nimport type { IsAny, RequiredDeep, ... } from '@hypernym/utils'\n```\n\n## is\n\n### isBrowser\n\nChecks if the code is running in the `browser`.\n\n```ts\nimport { isBrowser } from '@hypernym/utils'\n\nisBrowser // true\n```\n\n### isNull\n\nReturns a boolean if the given value is a `null`.\n\n```ts\nimport { isNull } from '@hypernym/utils'\n\nisNull(null) // true\n```\n\n### isUndefined\n\nReturns a boolean if the given value is a `undefined`.\n\n```ts\nimport { isUndefined } from '@hypernym/utils'\n\nisUndefined(undefined) // true\n```\n\n### isString\n\nReturns a boolean if the given value is a `string`.\n\n```ts\nimport { isString } from '@hypernym/utils'\n\nisString('@hypernym/utils') // true\n```\n\n### isStringEmpty\n\nReturns a boolean if the given value is an empty `string`.\n\n```ts\nimport { isStringEmpty } from '@hypernym/utils'\n\nisStringEmpty('') // true\n```\n\n### isBoolean\n\nReturns a boolean if the given value is a `boolean`.\n\n```ts\nimport { isBoolean } from '@hypernym/utils'\n\nisBoolean(true) // true\n```\n\n### isTrue\n\nReturns a boolean if the given value is a `true`.\n\n```ts\nimport { isTrue } from '@hypernym/utils'\n\nisTrue(true) // true\n```\n\n### isFalse\n\nReturns a boolean if the given value is a `false`.\n\n```ts\nimport { isFalse } from '@hypernym/utils'\n\nisFalse(false) // true\n```\n\n### isNumber\n\nReturns a boolean if the given value is a `number`.\n\n```ts\nimport { isNumber } from '@hypernym/utils'\n\nisNumber(33) // true\n```\n\n### isArray\n\nReturns a boolean if the given value is a `array`.\n\n```ts\nimport { isArray } from '@hypernym/utils'\n\nisArray([]) // true\n```\n\n### isArrayEmpty\n\nReturns a boolean if the given value is an empty `array`.\n\n```ts\nimport { isArrayEmpty } from '@hypernym/utils'\n\nisArrayEmpty([]) // true\n```\n\n### isObject\n\nReturns a boolean if the given value is a `object`.\n\n```ts\nimport { isObject } from '@hypernym/utils'\n\nisObject({}) // true\n```\n\n### isObjectEmpty\n\nReturns a boolean if the given value is an empty `object`.\n\n```ts\nimport { isObjectEmpty } from '@hypernym/utils'\n\nisObjectEmpty({}) // true\n```\n\n### isFunction\n\nReturns a boolean if the given value is a `Function`.\n\n```ts\nimport { isFunction } from '@hypernym/utils'\n\nisFunction(() => {}) // true\n```\n\n### isNanValue\n\nReturns a boolean if the given value is a `NaN`.\n\n```ts\nimport { isNaNValue } from '@hypernym/utils'\n\nisNaNValue(NaN) // true\n```\n\n### isRegExp\n\nReturns a boolean if the given value is a `RegExp`.\n\n```ts\nimport { isRegExp } from '@hypernym/utils'\n\nisRegExp(/^hypernym/) // true\n```\n\n### isMap\n\nReturns a boolean if the given value is a `Map`.\n\n```ts\nimport { isMap } from '@hypernym/utils'\n\nisMap(new Map()) // true\n```\n\n### isWeakMap\n\nReturns a boolean if the given value is a `WeakMap`.\n\n```ts\nimport { isWeakMap } from '@hypernym/utils'\n\nisWeakMap(new WeakMap()) // true\n```\n\n### isSet\n\nReturns a boolean if the given value is a `Set`.\n\n```ts\nimport { isSet } from '@hypernym/utils'\n\nisSet(new Set()) // true\n```\n\n### isWeakSet\n\nReturns a boolean if the given value is a `WeakSet`.\n\n```ts\nimport { isWeakSet } from '@hypernym/utils'\n\nisWeakSet(new WeakSet()) // true\n```\n\n### isSymbol\n\nReturns a boolean if the given value is a `symbol`.\n\n```ts\nimport { isSymbol } from '@hypernym/utils'\n\nisSymbol(Symboly('hypernym')) // true\n```\n\n### isDate\n\nReturns a boolean if the given value is a `Date`.\n\n```ts\nimport { isDate } from '@hypernym/utils'\n\nisDate(new Date()) // true\n```\n\n### isBigInt\n\nReturns a boolean if the given value is a `bigint`.\n\n```ts\nimport { isBigInt } from '@hypernym/utils'\n\nisBigInt(1n) // true\n```\n\n### isInfinity\n\nReturns a boolean if the given value is a `Infinity`.\n\n```ts\nimport { isInfinity } from '@hypernym/utils'\n\nisInfinity(Infinity) // true\n```\n\n### isURL\n\nReturns a boolean if the given value is a `URL`.\n\n```ts\nimport { isURL } from '@hypernym/utils'\n\nisURL(new URL('https://localhost:3000')) // true\n```\n\n### isError\n\nReturns a boolean if the given value is a `Error`.\n\n```ts\nimport { isError } from '@hypernym/utils'\n\nisError(new Error()) // true\n```\n\n### isPrimitive\n\nReturns a boolean if the given value is a `Primitive`.\n\n```ts\nimport { isPrimitive } from '@hypernym/utils'\n\nisPrimitive(true) // true\n```\n\n### isElement\n\nReturns a boolean if the given value is a `Element`.\n\n```ts\nimport { isElement } from '@hypernym/utils'\n\nisElement(el) // true\n```\n\n### isHtmlElement\n\nReturns a boolean if the given value is a `HTMLElement`.\n\n```ts\nimport { isHtmlElement } from '@hypernym/utils'\n\nisHtmlElement(htmlEl) // true\n```\n\n### isSvgElement\n\nReturns a boolean if the given value is a `SVGElement`.\n\n```ts\nimport { isSvgElement } from '@hypernym/utils'\n\nisSvgElement(svgEl) // true\n```\n\n### isNodeList\n\nReturns a boolean if the given value is a `NodeList`.\n\n```ts\nimport { isNodeList } from '@hypernym/utils'\n\nisNodeList(document.querySelectorAll('div')) // true\n```\n\n### isNodeListEmpty\n\nReturns a boolean if the given value is an empty `NodeList`.\n\n```ts\nimport { isNodeListEmpty } from '@hypernym/utils'\n\nisNodeListEmpty(document.querySelectorAll('divs')) // true\n```\n\n### isHtmlCollection\n\nReturns a boolean if the given value is a `HTMLCollection`.\n\n```ts\nimport { isHtmlCollection } from '@hypernym/utils'\n\nisHtmlCollection(document.getElementsByClassName('el')) // true\n```\n\n### isHtmlCollectionEmpty\n\nReturns a boolean if the given value is an empty `HTMLCollection`.\n\n```ts\nimport { isHtmlCollectionEmpty } from '@hypernym/utils'\n\nisHtmlCollectionEmpty(document.getElementsByClassName('els')) // true\n```\n\n## fs\n\n### exists\n\nChecks if the `file` or `directory` exists.\n\n```ts\nimport { exists } from '@hypernym/utils/fs'\n\nawait exists('dir/file.ts') // true\n```\n\n### read\n\nReads the entire contents of a `file`.\n\n```ts\nimport { read } from '@hypernym/utils/fs'\n\nawait read('dir/subdir/file.ts')\n```\n\n### readdir\n\nReads the contents of a `directory` recursively.\n\n```ts\nimport { readdir } from '@hypernym/utils/fs'\n\nawait readdir('dir/subdir')\n```\n\n### write\n\nWrites data to a `file` recursively.\n\n```ts\nimport { write } from '@hypernym/utils/fs'\n\nawait write('dir/subdir/file.ts', `console.log('Hello World!')`)\n```\n\n### copy\n\nCopies `files` or `directories` recursively.\n\nAccepts a single source or a range of sources.\n\n```ts\nimport { copy } from '@hypernym/utils/fs'\n\nawait copy('src/subdir/file.ts', './dist/subdir')\n```\n\n### mkdir\n\nCreates a `directory` recursively.\n\nAccepts a single path or a range of paths.\n\n```ts\nimport { mkdir } from '@hypernym/utils/fs'\n\nawait mkdir('src/subdir')\n```\n\n### remove\n\nRemoves `files` and `directories` recursively.\n\nAccepts a single path or a range of paths.\n\n```ts\nimport { remove } from '@hypernym/utils/fs'\n\nawait remove('src/subdir/file.ts')\n```\n\n## Types\n\n### Primitive\n\nMatches any primitive value.\n\n```ts\nimport type { Primitive } from '@hypernym/utils'\n\ntype OnlyPrimitives = T extends Primitive ? T : never\n\ntype Filtered = OnlyPrimitives // string | number\n```\n\n### BuiltIn\n\nMatches any `Primitive`, `Date` or `RegExp` value.\n\n```ts\nimport type { BuiltIn } from '@hypernym/utils'\n\ntype OnlyBuiltIns = T extends BuiltIn ? T : never\n\ntype Filtered = OnlyBuiltIns // string | Date | RegExp\n```\n\n### IsNull\n\nReturns a boolean if the given type is a `null`.\n\n```ts\nimport type { IsNull } from '@hypernym/utils'\n\ntype A = IsNull // true\ntype B = IsNull // false\ntype C = IsNull // false\n```\n\n### IsAny\n\nReturns a boolean if the given type is a `any`.\n\n```ts\nimport type { IsAny } from '@hypernym/utils'\n\ntype A = IsAny // true\ntype B = IsAny // false\ntype C = IsAny // false\n```\n\n### IsNever\n\nReturns a boolean if the given type is a `never`.\n\n```ts\nimport type { IsNever } from '@hypernym/utils'\n\ntype A = IsNever // true\ntype B = IsNever // false\ntype C = IsNever // false\n```\n\n### PartialDeep\n\nConstructs a type by recursively setting all properties as optional.\n\nUse `Partial` for one level.\n\n```ts\nimport type { PartialDeep } from '@hypernym/utils'\n\ntype PartialObject = PartialDeep