zenkai 0.10.2 | Documentation

zenkai

0.10.2

STD ▸
- Static members
- .insert
- .last
- .first
- .fetchWithTimeout
- .compareTime
- .resolveDate
- .formatDate
- .shortDate
- .shortDateTime
- .hasOwn
- .isDerivedOf
- .cloneObject
- .capitalize
- .capitalizeFirstLetter
- .formatCase
- .camelCase
- .pascalCase
- .removeAccents
- .boolToInt
- .toBoolean
- .valOrDefault
- .isEmpty
- .isDate
- .isString
- .isFunction
- .isObject
- .isIterable
- .isCollection
- .isNull
- .isNullOrWhitespace
- .isUndefined
- .isNullOrUndefined
- .assert
- .some
- .all
- .one
- .no
- .lone
- .random
- .addPath
- .getDir
- .getDirTarget
- .findByPath
isVowel
isConsonant
isUpperCase
isLowerCase

Need help reading this?

STD

Static Members

▸ insert(array, index, item)

Inserts an item in an array at the specified index

insert(array: Array<any>, index: number, item: object): number

Parameters

array (Array<any>) array

index (number)

item (object)

Returns

number: The new length of the array

▸ last(array)

Returns the last element of an array.

last(array: Array<any>)

Parameters

array (Array<any>) array

▸ first(array)

Returns the first element of an array.

first(array: Array<any>)

Parameters

array (Array<any>) array

▸ fetchWithTimeout(uri, options, time)

Creates a fetch request with a time limit to resolve the request

fetchWithTimeout(uri: URI, options: any, time: number)

Parameters

uri (URI)

options

(any
            = {})

time

(number
            = 5000)

▸ compareTime(t1, t2, separator)

Compare 2 times

compareTime(t1: string, t2: string, separator: string): number

Parameters

t1 (string) time 1

t2 (string) time 2

separator

(string
            = ":")

Returns

number: 1, 0, -1 if t1 > t2, t1 = t2 and t1 < t2 respectively

▸ resolveDate(value?, useOffset)

Resolves a date value

resolveDate(value: any?, useOffset: any): Date

Parameters

value (any?)

useOffset

(any
            = true)

Returns

Date:

▸ formatDate(date, format)

Formats a date

formatDate(date: !Date, format: !string): string

Parameters

date (!Date)

format (!string)

Returns

string: Formatted date

▸ shortDate(_date)

Returns a date and time using the format "YYYY-mm-dd"

shortDate(_date: any): string

Parameters

_date (any)

Returns

string:

▸ shortDateTime(_date)

Returns a date and time using the format "YYYY-mm-dd hh:MM"

shortDateTime(_date: any): string

Parameters

_date (any)

Returns

string:

▸ hasOwn

Returns a boolean indicating whether the object has the specified property as its own property (not inherited).

hasOwn

Parameters

obj (any) target object

key (string) name of the property

▸ isDerivedOf

Returns a boolean indicating whether the object (child) inherit from another object (parent)

isDerivedOf

Parameters

child (any)

parent (any)

▸ cloneObject(obj)

Creates a clone of an object

cloneObject(obj: any)

Parameters

obj (any) Object

▸ capitalize(str)

Capitalizes all words in a sequence

capitalize(str: string): string

Parameters

str (string) Sequence

Returns

string: Capitalized sequence

▸ capitalizeFirstLetter(str)

Capitalizes the first letter of a sequence

capitalizeFirstLetter(str: string): string

Parameters

str (string) Sequence

Returns

string: Sequence with its first letter capitalized

▸ formatCase(str, casing)

Format a sequence according to a specified case

formatCase(str: !string, casing: !string): string

Parameters

str (!string) Sequence

casing (!string) Casing (camel, pascal, upper, lower)

Returns

string: Formatted sequence

▸ camelCase(str)

Capitalizes all words in a sequence except the first one and removes spaces or punctuation

camelCase(str: !string): string

Parameters

str (!string) Sequence

Returns

string: camelCased sequence

▸ pascalCase(str)

Capitalizes all words in a sequence and removes spaces or punctuation

pascalCase(str: !string): string

Parameters

str (!string) Sequence

Returns

string: PascalCased sequence

▸ removeAccents(str)

Removes all accents from a string

removeAccents(str: !string): string

Parameters

str (!string) A string

Returns

string: A string without accents

▸ boolToInt(value)

Converts the received boolean value to an integer

boolToInt(value: boolean): number

Parameters

value (boolean)

Returns

number: 1 or 0

▸ toBoolean(value)

Converts the received value to a boolean

toBoolean(value: any): boolean

Parameters

value (any)

Returns

boolean: A boolean equivalent of the received value

▸ valOrDefault(arg, value, isNullable)

Returns an object value or default value if undefined

valOrDefault(arg: any, value: any, isNullable: boolean)

Parameters

arg (any) object

value (any) default value

isNullable

(boolean
            = false)

indicates whether the value can be assigned the value NULL

▸ isEmpty(obj, arr)

Returns a value indicating whether the value is empty

isEmpty(obj: any, arr: (Array<Object> | string)): boolean

Parameters

obj (any)

arr ((Array<Object> | string)) array

Returns

boolean:

▸ isDate(value)

Returns a value indicating whether the variable is a Date

isDate(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isString(value)

Returns a value indicating whether the variable is a String

isString(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isFunction(value)

Returns a value indicating whether the value is a Function

isFunction(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isObject(value)

Returns a value indicating whether the value is an Object

isObject(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isIterable(obj)

Returns a value indicating whether the object is iterable

isIterable(obj: any): boolean

Parameters

obj (any)

Returns

boolean:

▸ isCollection(obj)

Returns a value indicating whether the object is a non-string iterable

isCollection(obj: any): boolean

Parameters

obj (any)

Returns

boolean:

▸ isNull(value)

Returns a value indicating whether the value is null

isNull(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isNullOrWhitespace(value)

Returns a value indicating whether a string is null or made of whitespace.

isNullOrWhitespace(value: string): boolean

Parameters

value (string) string

Returns

boolean:

▸ isUndefined(value)

Returns a value indicating whether the value is undefined

isUndefined(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ isNullOrUndefined(value)

Returns a value indicating whether the value is null or undefined

isNullOrUndefined(value: any): boolean

Parameters

value (any)

Returns

boolean:

▸ assert

Verifies that the condition is satisfied for a specified number (range) of value

assert

Parameters

values (Array<any>) Set of values

pred (Function) Condition

min

(number
            = 1)

Minimum number of values that must satisfy the condition

max (number?) Maximum number of values that must satisfy the condition

Returns

boolean: A value indicating whether the condition is satisfied for the specified range

▸ some

Verifies that at least one value satisfies the condition

some

Parameters

values (Array<any>) Set of values

pred (Function) Condition

Returns

boolean: A value indicating whether at least one value satisfies the condition

▸ all

Verifies that all the values satisfy the condition

all

Parameters

values (Array<any>) Set of values

pred (Function) Condition

Returns

boolean: A value indicating whether all the values satisfy the condition

▸ one

Verifies that exactly one value satisfies the condition

one

Parameters

values (Array<any>) Set of values

pred (Function) Condition

Returns

boolean: A value indicating whether exactly one value satisfies the condition

▸ no

Verifies that no value satisfies the condition

Parameters

values (Array<any>) Set of values

pred (Function) Condition

Returns

boolean: A value indicating whether no value satisfies the condition

▸ lone

Verifies that at most one value satisfies the condition

lone

Parameters

values (Array<any>) Set of values

pred (Function) Condition

Returns

boolean: A value indicating whether at most one value satisfies the condition

▸ random(min, max?, secure = false)

Return a random integer between min and max (inclusive).

random(min: number, max: number?, secure: boolean?)

Parameters

min (number)

max (number?)

secure

(boolean?
            = false)

▸ addPath(target, path, separator)

Append the path to the current path

addPath(target: string, path: string, separator: string)

Parameters

target (string)

path (string)

separator

(string
            = ".")

▸ getDir(path, separator)

Returns the directory of the path

getDir(path: string, separator: string)

Parameters

path (string)

separator

(string
            = ".")

▸ getDirTarget(path, target)

Returns the directory of the path from the target

getDirTarget(path: string, target: any)

Parameters

path (string)

target (any)

▸ findByPath(obj, path, separator)

Returns an element in an object using its path

findByPath(obj: Object, path: string, separator: string)

Parameters

obj (Object)

path (string)

separator

(string
            = .)

isVowel

Verifies that a character is a vowel

isVowel(char: string)

Parameters

char (string) String character

isConsonant

Verifies that a character is a consonant

isConsonant(char: string)

Parameters

char (string) String character

isUpperCase

Verifies that a character is uppercase

isUpperCase(char: string)

Parameters

char (string) String character

isLowerCase

Verifies that a character is lowercase

isLowerCase(char: string)

Parameters

char (string) String character