extra-utils
Utilities for JavaScript and Typescript.
Install
npm install --save extra-utils
# or
yarn add extra-utils
API
ArrayLike
function first<T>(arr: ArrayLike<T>): T | undefined
function last<T>(arr: ArrayLike<T>): T | undefined
Array
function isArray<T>(val: unknown): val is Array<T>
function isntArray<T>(val: T): val is Exclude<T, Array<unknown>>
function isEmptyArray(val: unknown[]): boolean
function isntEmptyArray<T>(val: T[]): val is NonEmptyArray<T>
Boolean
function isBoolean(val: unknown): val is boolean
function isntBoolean<T>(val: unknown): val is Exclude<T, boolean>
function isFalsy(val: unknown): val is Falsy
function isntFalsy<T>(val: T): val is Exclude<T, Falsy>
JSON
function isJSONValue(val: unknown): val is JSONValue
function isntJSONValue<T>(val: T): val is Exclude<T, JSONValue>
function isJSONSerializable<T extends
| JSONValue
| Record<string, JSONValue | JSONSerializable<any>>
| Array<JSONValue | JSONSerializable<any>>
>(val: unknown): val is JSONSerializable<T>
function isntJSONSerializable<T>(val: T): val is Exclude<T, JSONSerializable<any>>
Nullish
function isNullish(val: unknown): val is Nullish
function isntNullish<T>(val: T): val is Exclude<T, Nullish>
function isNull(val: unknown): val is null
function isntNull<T>(val: T): val is Exclude<T, null>
function isUndefined(val: unknown): val is undefined
function isntUndefined<T>(val: T): val is Exclude<T, undefined>
Number
function isNumber(val: unknown): val is number
function isntNumber<T>(val: T): val is Exclude<T, number>
function isFinite(val: number): boolean
function isPositiveInfinity(val: number): boolean
function isNegativeInfinity(val: number): boolean
function isNaN(val: number): boolean
function isntNaN(val: number): boolean
function isBigInt(val: unknown): val is bigint
function isntBigInt<T>(val: T): val is Exclude<T, bigint>
Object
function isObject(
val: unknown
): val is object & Record<string | symbol | number, unknown>
function isntObject<T>(
val: T
): val is Exclude<T, object & Record<string | symbol | number, unknown>>
function isPlainObject(
val: unknown
): val is object & Record<string | symbol | number, unknown>
function isntPlainObject<T>(
val: T
): val is Exclude<T, object & Record<string | symbol | number, unknown>>
function isEmptyObject(val: object): boolean
function isntEmptyObject(val: object): boolean
function isReferenceEqual(a: unknown, b: unknown): boolean
function isShallowEqual(a: unknown, b: unknown): boolean
function isDeepEqual(a: unknown, b: unknown): boolean
String
function isString(val: unknown): val is string
function isntString<T>(val: T): val is Exclude<T, string>
function isChar(val: unknown): val is string
function isntChar(val: unknown): boolean
function isURLString(text: string): boolean
function isntURLString(text: string): boolean
function toString(val: unknown): string
removeExtraIndents
function removeExtraIndents(
text: string
, options?: { ignoreBlankLines: boolean = false }
): string
Example:
removeExtraIndents(`
hello
world
`, { ignoreBlankLines: true })
// '\n'
// + 'hello' + '\n'
// + '\n'
// + 'world' + '\n'
removeBlankLines
function removeBlankLines(text: string): string
Example:
removeBlankLines(
'\n'
+ 'hello' + '\n'
+ '\n'
+ 'world' + '\n'
+ '\n'
)
// 'hello' + '\n'
// + 'world'
removeLeadingBlankLines
function removeLeadingBlankLines(
text: string
, maxRemovals: number = Infinity
): string
Example:
removeLeadingBlankLines(
' ' + '\n'
+ 'a' + '\n'
+ ' '
)
// 'a' + '\n'
// + ' '
removeTrailingBlankLines
function removeTrailingBlankLines(
text: string
, maxRemovals: number = Infinity
): string
Example:
removeTrailingBlankLines(
' ' + '\n'
+ 'a' + '\n'
+ ' '
)
// ' ' + '\n'
// + 'a'
Enum
function inEnum<T>(val: unknown, _enum: object): val is T
function notInEnum<T, U>(val: T, _enum: object): val is Exclude<T, U>
Date
function isDate(val: unknown): val is Date
function isntDate<T>(val: T): val is Exclude<T, Date>
Function
function isFunction<T extends Function = (...args: any[]) => any>(
val: unknown
): val is T
function isntFunction<T>(val: T): val is Exclude<T, Function>
RegExp
function isRegExp(val: unknown): val is RegExp
function isntRegExp<T>(val: T): val is Exclude<T, RegExp>
Symbol
function isSymbol(val: unknown): val is symbol
function isntSymbol<T>(val: T): val is Exclude<T, symbol>
pipe
function pipe<A, B, C, D, E, F, G, H>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
, (value: C) => D
, (value: D) => E
, (value: E) => F
, (value: F) => G
, (value: G) => H
]
): H
function pipe<A, B, C, D, E, F, G>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
, (value: C) => D
, (value: D) => E
, (value: E) => F
, (value: F) => G
]
): G
function pipe<A, B, C, D, E, F>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
, (value: C) => D
, (value: D) => E
, (value: E) => F
]
): F
function pipe<A, B, C, D, E>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
, (value: C) => D
, (value: D) => E
]
): E
function pipe<A, B, C, D>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
, (value: C) => D
]
): D
function pipe<A, B, C>(
value: A
, ...operators: [
(value: A) => B
, (value: B) => C
]
): C
function pipe<A, B>(
value: A
, ...operators: [
(value: A) => B
]
): B
function pipe<T, U>(
value: T
, ...operators: Array<(value: any) => unknown>
): U
pipeAsync
function pipeAsync<A, B, C, D, E, F, G, H>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
, (value: C) => Awaitable<D>
, (value: D) => Awaitable<E>
, (value: E) => Awaitable<F>
, (value: F) => Awaitable<G>
, (value: G) => Awaitable<H>
]
): Promise<H>
function pipeAsync<A, B, C, D, E, F, G>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
, (value: C) => Awaitable<D>
, (value: D) => Awaitable<E>
, (value: E) => Awaitable<F>
, (value: F) => Awaitable<G>
]
): Promise<G>
function pipeAsync<A, B, C, D, E, F>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
, (value: C) => Awaitable<D>
, (value: D) => Awaitable<E>
, (value: E) => Awaitable<F>
]
): Promise<F>
function pipeAsync<A, B, C, D, E>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
, (value: C) => Awaitable<D>
, (value: D) => Awaitable<E>
]
): Promise<E>
function pipeAsync<A, B, C, D>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
, (value: C) => Awaitable<D>
]
): Promise<D>
function pipeAsync<A, B, C>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
, (value: B) => Awaitable<C>
]
): Promise<C>
function pipeAsync<A, B>(
value: Awaitable<A>
, ...operators: [
(value: A) => Awaitable<B>
]
): Promise<B>
function pipeAsync<T, U>(
value: Awaitable<T>
, ...operators: Array<(value: any) => Awaitable<unknown>>
): Promise<U>