@patrtorg/minima-exercitationem-minus NPM

@patrtorg/minima-exercitationem-minus / Exports

@patrtorg/minima-exercitationem-minus

Utility library in TypeScript, with a focus on Node and FP utils and emphasis on not rewriting builtin features.

Installation

npm i @patrtorg/minima-exercitationem-minus

Usage

See the docs below for details (generated from types and comments). Example:

import * as z from '@patrtorg/minima-exercitationem-minus'

const answer = await z.prompt('Pick a letter')
if (z.isEmpty(answer)) process.exit(1)

@patrtorg/minima-exercitationem-minus

Interfaces

Type Aliases

Variables

colorize

Functions

Type Aliases

AnyFn

Ƭ AnyFn: (...args: any[]) => any

Type declaration

▸ (...args): any

Parameters

Name	Type
`...args`	`any`[]

Returns

any

Defined in

pipe.ts:3

AnyMap

Ƭ AnyMap: Record\<string, any>

Defined in

types.ts:1

Cb

Ƭ Cb: (error: c.ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void

Type declaration

▸ (error, stdout, stderr): void

Parameters

Name	Type
`error`	`c.ExecFileException` \| `null`
`stdout`	`string` \| `Buffer`
`stderr`	`string` \| `Buffer`

Returns

void

Defined in

open.ts:4

ColMap

Ƭ ColMap: Record\<string, (t: string) => string>

Defined in

colorize.ts:4

F

Ƭ F: (...args: any[]) => any

Type declaration

▸ (...args): any

Parameters

Name	Type
`...args`	`any`[]

Returns

any

Defined in

curry.ts:1

Listener

Ƭ Listener: (a: AnyMap, b: AnyMap) => any

Type declaration

▸ (a, b): any

Parameters

Name	Type
`a`	`AnyMap`
`b`	`AnyMap`

Returns

any

Defined in

store.ts:3

R

Ƭ R: Record\<string, number>

Defined in

count-items-in-array.ts:1

R

Ƭ R: (...args: any[]) => Timer

Type declaration

▸ (...args): Timer

Parameters

Name	Type
`...args`	`any`[]

Returns

Timer

Defined in

debounce.ts:2

R

Ƭ R: string | any[] | AnyMap

Defined in

keep.ts:4

Timer

Ƭ Timer: NodeJS.Timeout | number | null

Defined in

debounce.ts:1

Updater

Ƭ Updater: (a: AnyMap) => AnyMap

Type declaration

▸ (a): AnyMap

Parameters

Name	Type
`a`	`AnyMap`

Returns

AnyMap

Defined in

store.ts:4

Variables

colorize

• Const colorize: ColMap

Defined in

colorize.ts:34

Functions

and

▸ and\<T>(a): boolean

Returns false if any in input array is false

Type parameters

Name
`T`

Parameters

Name	Type
`a`	`T`[]

Returns

boolean

Example

and([ 1, 2, 3 ]) // => true
and([ 1, 2, 3, false ]) // => false

Defined in

and.ts:8

average

▸ average(xs): number

Averages a list of numbers

Parameters

Name	Type
`xs`	`number`[]

Returns

number

Example

average([ 2, 4, 6, 8 ]) // => 5

Defined in

average.ts:7

basename

▸ basename(str?): string

basename for Node

Parameters

Name	Type	Default value
`str`	`string`	`''`

Returns

string

Example

basename() // => string

Defined in

basename.ts:9

camelCaseToLispCase

▸ camelCaseToLispCase(str): string

Takes a camelCase string and returns one in lisp-case

Parameters

Name	Type
`str`	`string`

Returns

string

Example

camelCaseToLispCase('fooBar') // => 'foo-bar'

Defined in

camel-case-to-lisp-case.ts:7

camelCaseToPascalCase

▸ camelCaseToPascalCase(str): string

Takes a camelCase string and returns one in PascalCase

Parameters

Name	Type
`str`	`string`

Returns

string

Example

camelCaseToPascalCase('fooBar') // => 'FooBar'

Defined in

camel-case-to-pascal-case.ts:7

camelCaseToSnakeCase

▸ camelCaseToSnakeCase(str): string

Takes a camelCase string and returns one in snake_case

Parameters

Name	Type
`str`	`string`

Returns

string

Example

camelCaseToSnakeCase('fooBar') // => 'foo_bar'

Defined in

camel-case-to-snake-case.ts:7

capitalizeFirstChar

▸ capitalizeFirstChar(str): string

Capitalizes the first character of string

Parameters

Name	Type
`str`	`string`

Returns

string

Example

capitalizeFirstChar('things and stuff') // => 'Things and stuff'

Defined in

capitalize-first-char.ts:7

chunk

▸ chunk\<T>(arr, n): T

Splits an array into chunks

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]
`n`	`number`

Returns

T

Example

chunk([1, 2, 3, 4 ], 2) // => [ [ 1, 2 ], [ 3, 4 ] ]

Defined in

chunk.ts:7

clamp

▸ clamp(val, min, max): number

Takes a number, min, and max If number is between min and max, returns number Otherwise returns min or max

Parameters

Name	Type
`val`	`number`
`min`	`number`
`max`	`number`

Returns

number

Example

clamp(100, 0, 1000) // => 100
clamp(100, 101, 1000) // => 101
clamp(100, 0, 99) // => 00

Defined in

clamp.ts:11

collapseNewlines

▸ collapseNewlines(str): string

Collapses multiple newlines to two

Parameters

Name	Type
`str`	`string`

Returns

string

Example

collapseNewlines('\n\n\n\n') // => '\n\n'

Defined in

collapse-newlines.ts:7

collapseWhitespace

▸ collapseWhitespace(str): string

Collapses consecutive whitespace to a single space

Parameters

Name	Type
`str`	`string`

Returns

string

Example

collapseWhitespace('a\n\r\t\nb') // => 'a b'

Defined in

collapse-whitespace.ts:7

collectBy

▸ collectBy(p): (a: any[]) => AnyMap

Collect an an array of objects by string key cred: gh:uniqname

Parameters

Name	Type
`p`	`string`

Returns

fn

▸ (a): AnyMap

Parameters

Name	Type
`a`	`any`[]

Returns

AnyMap

Example

const data = [ { foo: 'a', bar: 'baz' }, { foo: 'b', bar: 'quux' }, { foo: 'a', bar: 'whatever' } ]
collectBy('foo')(data) // => { a: { foo: 'a', bar: 'whatever' }, b: { foo: 'b', bar: 'quux' } }

Defined in

collect-by.ts:11

combineRegex

▸ combineRegex(rs, opts?): RegExp

Combines regular expressions

Parameters

Name	Type	Default value
`rs`	`RegExp`[]	`undefined`
`opts`	`string`	`''`

Returns

RegExp

Example

combineRegex([/[a-z]/, /[0-9]], 'g') ==> /[a-z][0-9]/g

Defined in

combine-regex.ts:7

compose

▸ compose\<T>(...fns): (t: T) => T

Right to left composition

Type parameters

Name
`T`

Parameters

Name	Type
`...fns`	(`t`: `T`) => `T`[]

Returns

fn

▸ (t): T

Parameters

Name	Type
`t`	`T`

Returns

T

Example

const addOne = (a) => a + 1
const timesTwo = (a) => a * 2
compose(addOne, timesTwo)(2) // => 5

Defined in

compose.ts:11

countIn

▸ countIn\<T>(el, ls): number

Find out how many of a given element is in an array or string.

Type parameters

Name
`T`

Parameters

Name	Type
`el`	`T`
`ls`	`string` \| `T`[]

Returns

number

Example

countIn('a', 'abc') // => 1
countIn('a', [ 'a', 'b', 'c' ]) // => 1

Defined in

count-in.ts:9

countItemsInArray

▸ countItemsInArray\<T>(arr): R

Get an object of items in an array with count

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]

Returns

R

Example

countItemsInArray([ 1, 1, 2, 3, 4 ]) // => { '1': 2, '2': 1, '3': 1, '4': 1 }

Defined in

count-items-in-array.ts:9

curry

▸ curry\<T>(fn): F

Takes a function and returns a function that takes any number of arguments

Produces a curried function

Type parameters

Name
`T`

Parameters

Name	Type
`fn`	`F`

Returns

F

Example

const addThree = (a, b, c) => a + b + c
curry(addThree)(1)(1)(1) // => 3

Defined in

curry.ts:13

debounce

▸ debounce(fn, ms): R

Simple debounce

Parameters

Name	Type
`fn`	(...`args`: `any`) => `any`
`ms`	`number`

Returns

R

Example

debounce(() => console.log('hi'), 5000)

Defined in

debounce.ts:10

diff

▸ diff\<T>(a, b): T[]

Diff two arrays

Type parameters

Name
`T`

Parameters

Name	Type
`a`	`T`[]
`b`	`T`[]

Returns

T[]

Example

diff([ 1, 2, 3 ], [ 2, 3 ]) // => [ 1 ]

Defined in

diff.ts:7

div

▸ div(ns): number

Divide any amount of numbers

Parameters

Name	Type
`ns`	`number`[]

Returns

number

Example

div([ 4, 2, 1 ]) // => 2

Defined in

div.ts:7

doubleUntil

▸ doubleUntil(minSize?): \<T>(arr: T[]) => T[]

Double an array until it's n long

Parameters

Name	Type	Default value
`minSize`	`number`	`0`

Returns

fn

▸ \<T>(arr): T[]

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]

Returns

T[]

Example

doubleUntil(2)([ 'hi' ]) // => [ 'hi', 'hi' ]

Defined in

double-until.ts:7

drop

▸ drop\<A>(n, arr): A[]

Like Haskell's drop

Type parameters

Name
`A`

Parameters

Name	Type
`n`	`number`
`arr`	`A`[]

Returns

A[]

Example

drop(2, [ 1, 2, 3 ]) // => 3

Defined in

drop.ts:7

dropWhile

▸ dropWhile\<T>(pred, arr): T[]

The opposite of takeWhile: takes a predicate and array and returns an array of the elements that didn't pass the predicate

Type parameters

Name
`T`

Parameters

Name	Type
`pred`	(`x`: `T`) => `boolean`
`arr`	`T`[]

Returns

T[]

Example

dropWhile(lessThanThree, [ 1, 2, 3, 4 ]) // => [ 3, 4 ]

Defined in

drop-while.ts:11

each

▸ each\<T>(xs, fn): Record\<string, any> | T[]

Takes an array or object and a function, and runs the function on each element

Type parameters

Name
`T`

Parameters

Name	Type
`xs`	`string` \| `any`[] \| `Record`\<`string`, `any`>
`fn`	(`a`: `any`, `b`: `string` \| `number`) => `T`

Returns

Record\<string, any> | T[]

Example

each([ 'a', 'b', 'c' ], id) // => 'a'

Defined in

each.ts:33

elem

▸ elem\<T>(el, ls): boolean

Check if a string or array contains an element

Type parameters

Name
`T`

Parameters

Name	Type
`el`	`string` & `T`
`ls`	`string` \| `T`[]

Returns

boolean

Example

elem('a', 'asdf') // => true
elem('a', 'asdf'.split('')) // => true

Defined in

elem.ts:8

escapeForRegex

▸ escapeForRegex(s?): string

Parameters

Name	Type	Default value
`s`	`string`	`''`

Returns

string

Example

escapeForRegex('foo') // => foo
escapeForRegex('1 \\ {} []|') // => '1 \\\\ \{\} \\[\\]\\|'

Defined in

escape-for-regex.ts:7

execute

▸ execute(cmd): void

Like a standalone npm run that obeys npm bin

Parameters

Name	Type
`cmd`	`string`

Returns

void

Example

execute('standard-format -w')

Defined in

execute.ts:15

fileExists

▸ fileExists(filePath): Promise\<boolean>

Returns bool based on if passed path exists

Parameters

Name	Type
`filePath`	`string`

Returns

Promise\<boolean>

Example

await fileExists('./foo') // => Promise<true>

Defined in

file-exists.ts:10

filter

▸ filter\<T>(fn, list): T[] | Record\<string, T>

filter for array and object

Type parameters

Name
`T`

Parameters

Name	Type
`fn`	(`x`: `T`, `y`: `string` \| `number`) => `boolean`
`list`	`string` \| `AnyMap` \| `T`[]

Returns

T[] | Record\<string, T>

Example

filter(id, [ 1, 2 ]) // => [ 1, 2 ]
filter(lessThanThree, [ 1, 2, 3, 4 ]) // => [ 1, 2 ]
filter(lessThanThree, { a: 1, b: 4 }) // =>  { a: 1 }

Defined in

filter.ts:14

findIndices

▸ findIndices(el, arr): number[]

Find all indices of an item in an array

Parameters

Name	Type
`el`	`any`
`arr`	`any`[]

Returns

number[]

Example

findIndices(1, [ 1, 2, 1 ]) // => [ 0, 2 ]

Defined in

find-indices.ts:7

findPort

▸ findPort(port, cb): void

Find next open port

Parameters

Name	Type
`port`	`number`
`cb`	(`x`: `null` \| `Error`, `y?`: `number`) => `void`

Returns

void

Example

findPort(8000, (err, port) => console.log(`${port} is open`))

Defined in

find-port.ts:13

flattenAndUniq

▸ flattenAndUniq\<T>(arr): T[]

Recursively flatten arrays then uniq what's left

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]

Returns

T[]

Example

flattenAndUniq([ 1, 2, 3, [ 1, 2, 3 ]]) // =>  [ 1, 2, 3 ]

Defined in

flatten-and-uniq.ts:10

flip

▸ flip(f): (...args: any[]) => any

Flips order of received arguments and calls f.

Parameters

Name	Type
`f`	(...`xs`: `any`[]) => `any`

Returns

fn

▸ (...args): any

Parameters

Name	Type
`...args`	`any`[]

Returns

any

Example

const minus = (a, b) => a - b
minus(2, 1) // => 1
flip(minus)(2, 1) // => -1

Defined in

flip.ts:9

fold

▸ fold\<T>(f, a): T

Applies f to first two items of list, then to next, etc.

Type parameters

Name
`T`

Parameters

Name	Type
`f`	(`x`: `T`, `y`: `T`) => `T`
`a`	`T`[]

Returns

T

Example

foldl1(increment, [ 1, 1, 1 ]) // => 3

Defined in

fold.ts:8

getFreeDisk

▸ getFreeDisk(): number

Get free disk space

Returns

number

Example

getFreeDisk()

Defined in

get-free-disk.ts:9

getFreeMemory

▸ getFreeMemory(): number

Get free memory

Returns

number

Example

getFreeMemory()

Defined in

get-free-memory.ts:9

getGlobal

▸ getGlobal(): undefined | typeof globalThis

Gets the global for your current context.

Returns

undefined | typeof globalThis

Example

getGlobal() // => window, global, whatever

Defined in

get-global.ts:7

getHashFromDate

▸ getHashFromDate(): string

Returns a hash based on current timestamp

Returns

string

Example

getHashFromDate()

Defined in

get-hash-from-date.ts:7

getHashFromSystem

▸ getHashFromSystem(): string

Get a md5 hash based on hostname, process.ppid, and date

Returns

string

Example

getHashFromSystem()

Defined in

get-hash-from-system.ts:10

getKeyByValue

▸ getKeyByValue(value, object): undefined | string

Get the key for a value

Parameters

Name	Type
`value`	`any`
`object`	`AnyMap`

Returns

undefined | string

Example

getKeyByValue('bar', { foo: 'bar' }) // => 'foo'

Defined in

get-key-by-value.ts:9

getLoadAverage

▸ getLoadAverage(): number

Get load average

Returns

number

Example

getLoadAverage()

Defined in

get-load-average.ts:10

getMemoryUsage

▸ getMemoryUsage(): number

Get memory usage

Returns

number

Example

getMemoryUsage()

Defined in

get-memory-usage.ts:9

getOrdinal

▸ getOrdinal(n): string

Adds ordinal onto integer

Works up to 999

Parameters

Name	Type
`n`	`number`

Returns

string

Example

getOrdinal(1) // => '1st'

Defined in

get-ordinal.ts:9

getProjectRoot

▸ getProjectRoot(): string

Get project root

Returns

string

Example

getProjectRoot() // /path/to/project

Defined in

get-project-root.ts:10

getRandomString

▸ getRandomString(n?): string

Returns random string of n length (defaults to 8)

Parameters

Name	Type	Default value
`n`	`number`	`8`

Returns

string

Example

getRandomString()
getRandomString(32)

Defined in

get-random-string.ts:8

getRegexFlags

▸ getRegexFlags(r): string[]

Returns the flags for a given regular expression

Parameters

Name	Type
`r`	`RegExp`

Returns

string[]

Example

getRegexFlags(/foo/ig) // => [ 'g', 'i' ]

Defined in

get-regex-flags.ts:7

getStdin

▸ getStdin(f): void

Get stdin and do something with it.

Parameters

Name	Type
`f`	(`a`: `string`) => `void`

Returns

void

Example

getStdin((str) => {
  console.log(str.split(''))
})

Defined in

get-stdin.ts:9

getTerminalColumns

▸ getTerminalColumns(): number

Get columns of current terminal

Returns

number

Example

getTerminalColumns()

Defined in

get-terminal-columns.ts:7

getTerminalRows

▸ getTerminalRows(): number

Get current terminal rows

Returns

number

Example

getTerminalRows()

Defined in

get-terminal-rows.ts:7

getTerminalSize

▸ getTerminalSize(): Size

Returns size of the current terminal

Returns

Size

Example

getTerminalSize() // => { columns: number, rows: number }

Defined in

get-terminal-size.ts:9

getUserHome

▸ getUserHome(): string

Get current user's home directory

Returns

string

Example

getUserHome() // => /home/z

Defined in

get-user-home.ts:11

getUserShell

▸ getUserShell(): string

Get the current user's shell, or an empty string on shell-less platforms

Returns

string

Example

getUserShell()

Defined in

get-user-shell.ts:8

greater

▸ greater(a, b): number

Get the greater of two numbers

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

number

Example

greater(1, 2) // => 2

Defined in

greater.ts:7

groupBy

▸ groupBy(p): (a: any[]) => AnyMap

Collect an an array of objects by string key

Parameters

Name	Type
`p`	`string`

Returns

fn

▸ (a): AnyMap

Parameters

Name	Type
`a`	`any`[]

Returns

AnyMap

Example

const data = [ { foo: 'a', bar: 'baz' }, { foo: 'b', bar: 'quux' }, { foo: 'a', bar: 'whatever' } ]
groupBy('foo')(data) // => { a: { foo: 'a', bar: 'whatever' }, b: { foo: 'b', bar: 'quux' } }

Defined in

group-by.ts:10

gt

▸ gt(a, b): boolean

Returns true if first param is greater than second param

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

boolean

Example

gt(2, 1) // => true
gt(1, 2) // => false

Defined in

gt.ts:8

gte

▸ gte(a, b): boolean

Returns true if first param is greater than or equal to second param

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

boolean

Example

gte(2, 2) // => true
gte(2, 1) // => true
gte(2, 3) // => false

Defined in

gte.ts:9

has

▸ has(p, o): boolean

See if an object has a property

Parameters

Name	Type
`p`	`string`
`o`	`AnyMap`

Returns

boolean

Example

has('a' { b: 'c' }) // => false

Defined in

has.ts:9

hasColor

▸ hasColor(): boolean

Returns true if the current terminal supports color

Returns

boolean

Example

hasColor()

Defined in

has-color.ts:14

hasDuplicate

▸ hasDuplicate\<T>(arr): boolean

Returns true if an array has any duplicate elements

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]

Returns

boolean

Example

hasDuplicate([ 1, 1, 2 ]) // => true

Defined in

has-duplicate.ts:8

head

▸ head\<T>(arr): T

First element

Type parameters

Name
`T`

Parameters

Name	Type
`arr`	`T`[]

Returns

T

Example

head([ 1, 2, 3 ]) // => 1

Defined in

head.ts:7

id

▸ id\<A>(a): A

id

Type parameters

Name
`A`

Parameters

Name	Type
`a`	`A`

Returns

A

Example

id(1) // => 1
id() // => undefined

Defined in

id.ts:8

init

▸ init(arr): any[]

Returns all but the last item of an array

Parameters

Name	Type
`arr`	`any`[]

Returns

any[]

Example

init([ 1, 2, 3 ]) // => [ 1, 2 ]

Defined in

init.ts:7

initials

▸ initials(str): string

Trims a string to just caps

Parameters

Name	Type
`str`	`string`

Returns

string

Example

initials('Zac Anger') // => 'ZA'

Defined in

initials.ts:7

intersection

▸ intersection\<T>(xs, ys): T[]

Get the intersection of two arrays

Type parameters

Name
`T`

Parameters

Name	Type
`xs`	`T`[]
`ys`	`T`[]

Returns

T[]

Example

intersection([ 1, 2 ], []) // => []
intersection([ 1, 2, 3 ], [1, 2]) // => [ 1, 2 ]

Defined in

intersection.ts:8

is

▸ is(t, val): boolean

Returns true if the value is of the type

Parameters

Name	Type
`t`	`string`
`val`	`any`

Returns

boolean

Example

is('number', 2) // => true

Defined in

is.ts:7

isArrayLike

▸ isArrayLike(v): boolean

Returns true if the passed value is array-like

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isArrayLike({}) // => false
isArrayLike([ 1, 2 ]) // => true

Defined in

is-array-like.ts:10

isBetween

▸ isBetween(a, b, mid): boolean

Returns true if the last parameter is before the first and second parameters

Parameters

Name	Type
`a`	`number`
`b`	`number`
`mid`	`number`

Returns

boolean

Example

isBetween(1, 3, 2) // => true
isBetween(2, 1, 2) // => false

Defined in

is-between.ts:13

isBoolean

▸ isBoolean(v): boolean

Returns true if the value is a boolean

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isBoolean(true) // => true

Defined in

is-boolean.ts:7

isClass

▸ isClass(fn): boolean

Returns true if passed fn is an ES2015 class

Parameters

Name	Type
`fn`	() => `any`

Returns

boolean

Example

isClass(noop) // => false

Defined in

is-class.ts:12

isDate

▸ isDate(v): boolean

Returns true if the value is a date

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isDate(new Date()) // => true

Defined in

is-date.ts:9

isDefined

▸ isDefined(v): boolean

Returns true if the value is defined

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isDefined(null) // => true

Defined in

is-defined.ts:7

isDirectory

▸ isDirectory(filePath): Promise\<boolean>

Returns true if the path is a directory

Parameters

Name	Type
`filePath`	`string`

Returns

Promise\<boolean>

Example

await isDirectory('.') // => true
await isDirectory('./fake-path') // => false

Defined in

is-directory.ts:11

isEmpty

▸ isEmpty(v): boolean

Returns true if the value is empty

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isEmpty('') // => true
isEmpty({}) // => true
isEmpty([]) // => true
isEmpty(null) // => true

Defined in

is-empty.ts:14

isError

▸ isError(a): boolean

Returns true if value is an error

Parameters

Name	Type
`a`	`any`

Returns

boolean

Example

isError(new Error()) // => true

Defined in

is-error.ts:9

isEven

▸ isEven(n): boolean

Returns true if the number is even

Parameters

Name	Type
`n`	`number`

Returns

boolean

Example

isEven(2) // => true

Defined in

is-even.ts:7

isFile

▸ isFile(filePath): Promise\<boolean>

Returns true if the path is a file

Parameters

Name	Type
`filePath`	`string`

Returns

Promise\<boolean>

Example

isFile('./README.md') // => true
isFile('.') // => false

Defined in

is-file.ts:11

isFloat

▸ isFloat(n): boolean

Returns true if the number is a float

Parameters

Name	Type
`n`	`number`

Returns

boolean

Example

isFloat(2) // => false
isFloat(2.2) // => true

Defined in

is-float.ts:8

isFunction

▸ isFunction(v): boolean

Returns true if the value is a function

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

const noop = () => {}
isFunction(2) // => false
isFunction(noop) // => true

Defined in

is-function.ts:9

isGenerator

▸ isGenerator(v): boolean

Returns true if passed val is a generator

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isGenerator(2) // => false

Defined in

is-generator.ts:7

isGeneratorFunction

▸ isGeneratorFunction(v): boolean

Returns true if val is a generator function

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isGeneratorFunction(2) // => false

Defined in

is-generator-function.ts:7

isInstalled

▸ isInstalled(pkgName): boolean

Returns true if the passed node_module name is installed

Parameters

Name	Type
`pkgName`	`string`

Returns

boolean

Example

isInstalled('@patrtorg/minima-exercitationem-minus') // => true

Defined in

is-installed.ts:7

isInteger

▸ isInteger(v): boolean

Returns true if the value is an integer

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isInteger(2) // => true
isInteger(1.1) // => false

Defined in

is-integer.ts:8

isJson

▸ isJson(str): boolean

Returns true if the string is valid JSON

Parameters

Name	Type
`str`	`string`

Returns

boolean

Example

isJson(JSON.stringify({ a: 'b' })) // => true

Defined in

is-json.ts:7

isMap

▸ isMap(v): boolean

Returns true if value is a map

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isMap(new Map()) // => true

Defined in

is-map.ts:9

isNode

▸ isNode(): boolean

Returns true if code is in Node

Returns

boolean

Example

isNode()

Defined in

is-node.ts:7

isNull

▸ isNull(v): boolean

Returns true if the value is null

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isNull(null) // => true

Defined in

is-null.ts:7

isNullOrUndefined

▸ isNullOrUndefined(v): boolean

Returns true if the value is null or undefined

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isNullOrUndefined(null) // => true

Defined in

is-null-or-undefined.ts:10

isNumber

▸ isNumber(v): boolean

Returns true if the value is a number and is not NaN

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isNumber(2) // => true
isNumber(NaN) // => false

Defined in

is-number.ts:8

isObject

▸ isObject(v): boolean

Returns true if the value is an object

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isObject('asdf') // => false

Defined in

is-object.ts:7

isOdd

▸ isOdd(n): boolean

Returns true if the number is odd

Parameters

Name	Type
`n`	`number`

Returns

boolean

Example

isOdd(1) // => true

Defined in

is-odd.ts:7

isPow2

▸ isPow2(n): boolean

Returns true if number is a power of two

Parameters

Name	Type
`n`	`number`

Returns

boolean

Example

isPow2(16) // => true

Defined in

is-pow-2.ts:7

isPrimitive

▸ isPrimitive(v): boolean

Returns true if value is a primitive

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isPrimitive(1) // => true

Defined in

is-primitive.ts:7

isPromise

▸ isPromise(a): boolean

Returns true if value is a promise

Parameters

Name	Type
`a`	`any`

Returns

boolean

Example

isPromise(Promise.resolve())

Defined in

is-promise.ts:7

isRegExp

▸ isRegExp(v): boolean

Returns true if value is a RegExp

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isRegExp(/a/) // => true

Defined in

is-reg-exp.ts:9

isRoot

▸ isRoot(): boolean

Check if current process is running as root.

Returns

boolean

Example

isRoot() // => true

Defined in

is-root.ts:7

isSemver

▸ isSemver(v): boolean

Returns true if the provided string is a valid semantic version

Parameters

Name	Type
`v`	`string`

Returns

boolean

Example

isSemver("0.0.0") // => true
isSemver("0.") // => false

Defined in

is-semver.ts:8

isSet

▸ isSet(v): boolean

Returns true if value is a set

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isSet(new Set()) // => true

Defined in

is-set.ts:9

isString

▸ isString(v): boolean

Returns true if value is a string

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isString('a') // => true

Defined in

is-string.ts:7

isSymLink

▸ isSymLink(filePath): Promise\<boolean>

Returns true if path is a symlink

Parameters

Name	Type
`filePath`	`string`

Returns

Promise\<boolean>

Example

isSymLink('.') // => false

Defined in

is-sym-link.ts:10

isSymbol

▸ isSymbol(a): boolean

Returns true if value is a symbol

Parameters

Name	Type
`a`	`any`

Returns

boolean

Example

isSymbol(Symbol.for('foo')) // => true

Defined in

is-symbol.ts:7

isUndefined

▸ isUndefined(v): boolean

Returns true if value is undefined

Parameters

Name	Type
`v`	`any`

Returns

boolean

Example

isUndefined(undefined) // => true

Defined in

is-undefined.ts:7

isValidDate

▸ isValidDate(d): boolean

Returns true if the passed object is a valid Date

Parameters

Name	Type
`d`	`Date`

Returns

boolean

Example

isValidDate('1234') // => false

Defined in

is-valid-date.ts:9

keep

▸ keep(x): R

Returns an array or object with all falsey values removed

Parameters

Name	Type
`x`	`R`

Returns

R

Example

keep([ 'a', null, '', 2]) // => [ 'a', 2 ]
keep({ a: '', b: null, c: 2 }) // => { c: 2 }

Defined in

keep.ts:13

last

▸ last\<A>(arr): A

Returns the last element of the array

Type parameters

Name
`A`

Parameters

Name	Type
`arr`	`A`[]

Returns

A

Example

last([ 1, 2, 3 ]) // => 3

Defined in

last.ts:7

len

▸ len(val): number

Get length of element

Works for array, object, string, set, map, and function

Parameters

Name	Type
`val`	`any`

Returns

number

Example

len('foo') // => 3
len([ 1, 2 ]) => 2
len((a, b) => a + b) // => 2

Defined in

len.ts:19

lesser

▸ lesser(a, b): number

Returns the lesser of two numbers

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

number

Example

lesser(1, 2) // => 1

Defined in

lesser.ts:7

lightenOrDarken

▸ lightenOrDarken(col, amt): string

Lighten or darken a color

Parameters

Name	Type
`col`	`string`
`amt`	`number`

Returns

string

Example

// lighten
const newCol = lightenOrDarken('#F06D06', 20)
// darken
const newCol = lightenOrDarken('#F06D06', -20)

Defined in

lighten-or-darken.ts:10

lines

▸ lines(str): string[]

Split a string on lines

Parameters

Name	Type
`str`	`string`

Returns

string[]

Example

lines('foo\nbar') // => [ 'foo', 'bar' ]

Defined in

lines.ts:7

lispCaseToCamelCase

▸ lispCaseToCamelCase(str): string

From lisp-case to camelCase

Parameters

Name	Type
`str`	`string`

Returns

string

Example

lispCaseToCamelCase('foo-bar') // => 'fooBar'

Defined in

lisp-case-to-camel-case.ts:7

lispCaseToPascalCase

▸ lispCaseToPascalCase(str): string

From lisp-case to PascalCase

Parameters

Name	Type
`str`	`string`

Returns

string

Example

lispCaseToPascalCase('foo-bar') // => 'FooBar'

Defined in

lisp-case-to-pascal-case.ts:7

lispCaseToSnakeCase

▸ lispCaseToSnakeCase(str): string

From lisp-case to snake_case

Parameters

Name	Type
`str`	`string`

Returns

string

Example

lispCaseToSnakeCase('foo-bar') // => 'foo_bar'

Defined in

lisp-case-to-snake-case.ts:7

lt

▸ lt(a, b): boolean

Returns true if first param is less than second param

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

boolean

Example

lt(2, 1) // => false

Defined in

lt.ts:7

lte

▸ lte(a, b): boolean

Returns true if first param is less than or equal to second param

Parameters

Name	Type
`a`	`number`
`b`	`number`

Returns

boolean

Example

lte(2, 1) // => false
lte(1, 1) // => true

Defined in

lte.ts:8

mapObject

▸ mapObject(f, o, ctx?): AnyMap

Map for objects

Parameters

Name	Type
`f`	(`a`: `any`, `b`: `string`, `c`: `any`) => `any`
`o`	`AnyMap`
`ctx`	`any`

Returns

AnyMap

Example

const f = (a) => a + ' world'
const d = { a: 'hello', b: 'sup' }
mapObject(f, d) // => { a: 'hello world', b: 'sup world' }

Defined in

map-object.ts:11

memoize

▸ memoize(fn): any

A simple memoizing util

Parameters

Name	Type
`fn`	`any`

Returns

any

Example

memoize((a) => a) // => [Function]
memoize((a) => a)(1) // => 1

Defined in

memoize.ts:8

mzero

▸ mzero(v?): any

Get monadic empty/zero value for a type

Parameters

Name	Type
`v?`	`any`

Returns

any

Example

mzero(1) // =>
mzero([1]) // => []

Defined in

mzero.ts:10

nco

▸ nco\<A, B>(variable, defaultValue): A | B

nco

Type parameters

Name
`A`
`B`

Parameters

Name	Type
`variable`	`A`
`defaultValue`	`B`

Returns

A | B

Example

nco(null, 1) // => 1
nco(1, 2) // => 1

Defined in

nco.ts:9

noop

▸ noop(): void

noop

Returns

void

Example

noop() // => undefined

Defined in

noop.ts:8

notElem

▸ notElem\<T>(el, ls): boolean

The opposite of elem

Returns true if the element is not in the string or array

Type parameters

Name
`T`

Parameters

Name	Type
`el`	`T` & `string`
`ls`	`string` \| `T`[]

Returns

boolean

Example

notElem('a', 'asdf') // => false
notElem('b', 'asdf') // => true

Defined in

not-elem.ts:12

objectToString

▸ objectToString(v): string

toString

Parameters

Name	Type
`v`	`any`

Returns

string

Example

objectToString({}) // => '[object Object]'

Defined in

object-to-string.ts:7

once

▸ once\<U>(fn): (...args: U[]) => U

Only calls fn once; subsequent calls just return first val

Type parameters

Name
`U`

Parameters

Name	Type
`fn`	\<T>(...`args`: `T`[]) => `T`

Returns

fn

▸ (...args): U

Parameters

Name	Type
`...args`	`U`[]

Returns

U

Example

const o = once(id)
o(1) // => 1
o() // => 1
o(2) // => 1

Defined in

once.ts:10

open

▸ open(args, opts, cb): void

Opens things. Works on Linux, Mac, and Windows

Parameters

Name	Type
`args`	`string`
`opts`	`AnyMap`
`cb`	`Cb`

Returns

void

Example

open('http://zacanger.com')

Defined in

open.ts:12

pair

▸ pair\<A, B>(first, second): A, B

Make a pair out of any two values

Type parameters

Name
`A`
`B`

Parameters

Name	Type
`first`	`A`
`second`	`B`

Returns

A, B

Example

pair('a', 'b') // => [ 'a', 'b' ]

Defined in

pair.ts:7

pairWith

▸ pairWith\<T>(f, a, b): T[]

Returns an array made by calling f on a and b.

Type parameters

Name
`T`

Parameters

Name	Type
`f`	(`x`: `T`) => `T`

| `a

ECMAScript 5 formatting transpile stringifier setImmediate flux bootstrap less client weakset preprocessor negative zero invariant reducer stringify upload react-testing-library offset traverse bin execfile Promise eventEmitter ES7 internal joi slice state certificates drag chinese mkdir URLSearchParams swf spinner isConcatSpreadable cloudtrail Symbol.toStringTag obj util fullwidth clone figlet some .env ECMAScript 2017 graphql cache argument make dir rapid internal slot pipe glacier performant validate dayjs findLast shared ansi cloudsearch trimRight css variable ES2017 endpoint ie worker call-bound toSorted lockfile jsdom protocol-buffers expression validator parser inference object beanstalk map wait parse testing Iterator mapreduce react pose mixins window option art Object.values data array rds drop ECMAScript equal async @@toStringTag every classnames es2017 ECMAScript 7 console password zod signals Array.prototype.flatten .gitignore guid dotenv Array.prototype.flatMap apollo ECMAScript 2018 pnpm9 string coercible Function.prototype.name tdd regexp file system ponyfill sameValueZero error cloudwatch Int16Array ender less mixins ES5 io-ts sequence dataView is properties number api in ECMAScript 2020 hardlinks jQuery native has a11y east-asian-width Underscore JSON-Schema Int8Array env findLastIndex amazon proto whatwg getopt escape eventDispatcher irq Object.is progress parsing streams s3 set config idle effect-ts copy waf getintrinsic 0 ses ArrayBuffer#slice helpers indicator css-in-js animation shrinkwrap sharedarraybuffer Streams ES2020 react animation ECMAScript 2021 Object.fromEntries collection keys fast-clone ecmascript postcss RegExp#flags typed has-own dom busy let weakmap redact toStringTag full-width Map binaries jshint globalThis babel slot iam ebs hash assertion l10n postcss-plugin merge ES2021 values lesscss create chrome readablestream callbound query encryption ast exit exit-code node require from structuredClone replay uninstall RxJS es8 pose ECMAScript 6 error-handling cjk live trimLeft color URL intrinsic dataview utils storagegateway uuid descriptors commander stable collection.es6 regular tostringtag negative stream hookform typedarrays directory superagent json-schema less css column call-bind function.length banner serialization ES2023 elb Object.assign visual windows reduce accessor es2018 tools symlink elm efficient String.prototype.matchAll elasticache agent jsdiff ramda framer asterisks jsonschema reuse Microsoft deep install utility Array.prototype.includes metadata byteOffset bundler random logger StyleSheet route args bootstrap css styleguide identifiers shell es5 stylesheet Array.prototype.findLastIndex browserlist matchAll text harmony forEach environment enumerable chromium route53 modules [[Prototype]]ECMAScript 2019 popmotion descriptor buffer emr trimEnd walk css less acorn react-component getter picomatch operating-system bind i18n tslib transport typeof tacit tc39 npm trimStart sorted toArray safe redux delete check accessibility Uint32Array Rx arraybuffer value Int32Array optimist setter match input es2016 language WeakMap file toobject preserve-symlinks logging core regex pretty log es description spring installer contains fp pyyaml which command-line starter auth flatten diff Uint8Array yup global object lru japanese ReactiveExtensions compile less variables in css sham regular expression cloudformation styling importexport sigint routing side zero 256 curried nodejs link execute typedarray syntax consume iterate omit ES2022 rules fnmatch superstruct spawn assign variables equality ES2016 key less compiler immutable rfc4122 name shebang Float64Array fastcopy dir BigInt64Array package.json curl browserslist hot quote es7 jwt speed rgb deep-clone gestures npmignore byte ES3 pino full concatMap serialize xhr vpc request YAML forms process fork sort interrupts libphonenumber electron gitignore AsyncIterator colour Symbol ArrayBuffer typanion loadbalancing https typed array module querystring scheme-validation nope make sigterm reversed valid handlers take three positive macos dom-testing-library tty writable util.inspect eslintconfig defineProperty columns trim workspace:*es-abstract Stream express output configurable type subprocess schema ECMAScript 3 Push prune utilities classname json __proto__const es-shims immer form settings censor date ajax concat listeners promise linux fast-deep-clone ES classes qs gradients css3 Object react-hooks $.extend setPrototypeOf symbol width css nesting HyBi circular react gradients css prop prefix css byteLength entries CSS lazy fast rfc9562 less.js symlinks sqs read functional getOwnPropertyDescriptor get ReactiveX buffers minimal Array.prototype.contains CSSStyleDeclaration mkdirp TypeBox call fast-deep-copy react-hook-form robust nested css character WebSocket multi-package openssl compare WebSockets reverse queueMicrotask js local validation sns styled-components spec Set browser assert eslintplugin url jest ESnext tester signed runtime aws phone queue -0 vest property names fast-copy filter polyfill find private last style push exec javascript RFC-6455 mru pure wget global this value estree ES6 recursive readable crypto String.prototype.trim Object.keys class-validator real-time simpledb Observable spinners Array package manager ES2015 awesomesauce toolkit TypedArray serializer es-shim API channel loading status deepcopy json-schema-validator fantasy-land shim jsx redux-toolkit 3d once events ES2018 ajv length ECMAScript 2023 dependency manager toReversed ES8 Array.prototype.flat telephone hasOwnProperty arktype core-js eslint asserts ignore korean types term ArrayBuffer.prototype.slice lint iterator prototype ES2019 view argv path helper inspect ECMAScript 2022 crypt dependencies warning proxy TypeScript http private data 6to5 computed-types var json-schema-validation datastructure Object.defineProperty transpiler bdd deterministic packages ECMAScript 2016 monorepo globals ts includes child hooks define yaml callback ascii plugin bundling flat airbnb format fixed-width es6 JSON waapi flags rangeerror kinesis touch groupBy zx time deep-copy persistent group System.global patch autoscaling fs resolve

@patrtorg/a-ad-expedita @patrtorg/a-ut-amet @patrtorg/architecto-rerum-eos @patrtorg/asperiores-vel-accusantium @patrtorg/aspernatur-dolorum-ducimus @patrtorg/autem-et-hic @patrtorg/consectetur-culpa-non @patrtorg/consectetur-repudiandae-consequuntur @patrtorg/consequatur-voluptatum-officiis @patrtorg/cumque-alias-facilis @patrtorg/ducimus-magni-quibusdam @patrtorg/enim-magni-hic @patrtorg/est-corrupti-deleniti @patrtorg/eveniet-tempore-maiores @patrtorg/illum-sapiente-quos @patrtorg/laborum-doloribus-voluptate @patrtorg/libero-doloribus-omnis @patrtorg/libero-voluptas-sequi @patrtorg/magnam-aut-adipisci @patrtorg/maiores-quidem-quo @patrtorg/molestias-molestias-ut @patrtorg/nam-eius-unde @patrtorg/numquam-doloribus-sit @patrtorg/pariatur-deleniti-quaerat @patrtorg/porro-labore-eos @patrtorg/quae-earum-eius @patrtorg/quos-quasi-ipsa @patrtorg/sapiente-eos-magnam @patrtorg/sapiente-exercitationem-sit @patrtorg/tenetur-animi-reprehenderit

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

@patrtorg/minima-exercitationem-minus

Installation

Usage

@patrtorg/minima-exercitationem-minus

Table of contents

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AnyFn

Type declaration

Parameters

Returns

Defined in

AnyMap

Defined in

Cb

Type declaration

Parameters

Returns

Defined in

ColMap

Defined in

F

Type declaration

Parameters

Returns

Defined in

Listener

Type declaration

Parameters

Returns

Defined in

R

Defined in

R

Type declaration

Parameters

Returns

Defined in

R

Defined in

Timer

Defined in

Updater

Type declaration

Parameters

Returns

Defined in

Variables

colorize

Defined in

Functions

and

Type parameters

Parameters

Returns

Defined in

average

Parameters

Returns

Defined in

basename

Parameters

Returns

Defined in

camelCaseToLispCase

Parameters

Returns

Defined in

camelCaseToPascalCase

Parameters

Returns

Defined in

camelCaseToSnakeCase

Parameters

Returns

Defined in

capitalizeFirstChar