chorecore v4.1.0

ChoreCore

Alphabet

Objects

alphabet

Contains the alphabet in an abundance of variants in Array form.

alphabet.strings

Contains the alphabet in an abundance of variants in String form.

Methods

All constants have an accompanying method that will simply return the character at the index passed to it

• lowercaseAt(i: number): string

• uppercaseAt(i: number): string

• lowercaseVowelAt(i: number): string

• uppercaseVowelAt(i: number): string

• lowercaseNonVowelAt(i: number): string

• uppercaseNonVowelAt(i: number): string

Conditionals

Conditional functions were created to simplify ternary operations when you only want to define one condition.

This is often most useful in string interpolation, but is definitely not limited to this.

isEven(testVal: number, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is even, the returnVal is returned, otherwise it will return elseVal.

isEqual(originalVal: any, testVal: any, returnVal: any = originalVal, sameType: boolean = true, elseVal: any = ''): any

If the originalVal and testVal are equal, the returnVal is returned, otherwise it will return elseVal.

The sameType parameter determines whether to test type equality too. When true it will use ===, when false it will use ==.

isFalse(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is false, the returnVal is returned, otherwise it will return elseVal.

isGT: (originalVal: any, testVal: any, returnVal: any = originalVal, elseVal = ''): any

If the originalVal is greater than the testVal, the returnVal is returned, otherwise it will return elseVal.

isGTE: (originalVal: any, testVal: any, returnVal: any = originalVal, elseVal = ''): any

If the originalVal is greater than or equal to the testVal, the returnVal is returned, otherwise it will return elseVal.

isLT: (originalVal: any, testVal: any, returnVal: any = originalVal, elseVal = ''): any

If the originalVal is less than the testVal, the returnVal is returned, otherwise it will return elseVal.

isLTE: (originalVal: any, testVal: any, returnVal: any = originalVal, elseVal = ''): any

If the originalVal is less than or equal to the testVal, the returnVal is returned, otherwise it will return elseVal.

isNotEqual(originalVal: any, testVal: any, returnVal: any = originalVal, sameType: boolean = true, elseVal: any = ''): any

If the originalVal and testVal are not equal, the returnVal is returned, otherwise it will return elseVal.

The sameType parameter determines whether to test type equality too. When true it will use !==, when false it will use !=.

isNotNull(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is not null, the returnVal is returned, otherwise it will return elseVal.

isNotUndefined(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is not undefined, the returnVal is returned, otherwise it will return elseVal.

isNull(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is null, the returnVal is returned, otherwise it will return elseVal.

isOdd(testVal: number, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is odd, the returnVal is returned, otherwise it will return elseVal.

isTrue(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is true, the returnVal is returned, otherwise it will return elseVal.

isUndefined(testVal: any, returnVal: any = testVal, elseVal: any = ''): any

If the testVal is undefined, the returnVal is returned, otherwise it will return elseVal.

Math

closest(needle: number, arr: number[]): number

This method will return the closest value in the array to the needle

Example:

closest(8, [1, 7, 3, 10, 5]) 
// returns 7

parseFractionString(fraction: string): number

This method parses a function written in out in a string and returns the number as a decimal

Strings

capitalize(alterVal: string): string

This method will return an altered version of the string provided which only ensures the first letter is capitalized

sentenceCase(alterVal: string): string

This method will alter the provided string by capitalizing the first letter, and making all other letters lowercase.

Time

Object

time

Contains all time constants in milliseconds (Units such as months and up are not included as they are not constant).

Methods

All constants have an accompanying method that will simply return that unit in milliseconds multiplied by the argument you pass in.

• days(multiplier: number): number

• hours(multiplier: number): number

• milliseconds(multiplier: number): number

• minutes(multiplier: number): number

• seconds(multiplier: number): number

• weeks(multiplier: number): number

Symbols

Object

fraction

Contains all Unicode fraction symbols

Method

fractionToSymbol(originalVal: number | string): string

This method accepts a fraction (either as a number or a string) and returns the closest value from the list of symbols above

Throws an error if the provided value is less than or equal to -1, or greater than or equal to 1