common/src | @bimeister/utilities

Functions

blobToFile

blobToFile(binary: Blob, fileName: string): File

- Defined in common/src/blob-to-file.function.ts:1
Parameters
- binary: Blob
- fileName: string
Returns File

bytesToShortestUnit

bytesToShortestUnit(bytesCount: number): string

- Defined in common/src/bytes-to-shortest-unit.function.ts:3
Parameters
- bytesCount: number
Returns string

downloadFile

downloadFile(filename: string, data: string | Blob): void

- Defined in common/src/download-file.function.ts:1
Parameters
- filename: string
- data: string | Blob
Returns void

fileListToArray

fileListToArray(fileList: FileList): File[]

- Defined in common/src/file-list-to-array.function.ts:4
Parameters
- fileList: FileList
Returns File[]

getAbbreviatedCount

getAbbreviatedCount(count: Nullable<number>): string | null

- Defined in common/src/get-abbreviated-count.function.ts:9
Parameters
- count: Nullable<number>
Returns string | null

getArrayBufferFromString

getArrayBufferFromString(inputString: Nullable<string>): Uint8Array | null

- Defined in common/src/get-array-buffer-from-string.function.ts:4
Parameters
- inputString: Nullable<string>
Returns Uint8Array | null

getArrayFirstElement

getArrayFirstElement<T>(array: T[]): T | undefined

- Defined in common/src/get-array-first-element.function.ts:3
Type Parameters
- T
Parameters
- array: T[]
Returns T | undefined

getArrayLastElement

getArrayLastElement<T>(array: T[]): T | undefined

- Defined in common/src/get-array-last-element.function.ts:3
Type Parameters
- T
Parameters
- array: T[]
Returns T | undefined

getArrayUniqueElements

getArrayUniqueElements(array: []): []
getArrayUniqueElements(array: number[]): number[]
getArrayUniqueElements(array: boolean[]): boolean[]
getArrayUniqueElements(array: string[]): string[]
getArrayUniqueElements<T>(array: T[]): T[]
getArrayUniqueElements<T, K>(array: T[], compareBy: number | symbol | K): T[]

- Defined in common/src/get-array-unique-elements.function.ts:8
Parameters
- array: []
Returns []
- Defined in common/src/get-array-unique-elements.function.ts:9
Parameters
- array: number[]
Returns number[]
- Defined in common/src/get-array-unique-elements.function.ts:10
Parameters
- array: boolean[]
Returns boolean[]
- Defined in common/src/get-array-unique-elements.function.ts:11
Parameters
- array: string[]
Returns string[]
- Defined in common/src/get-array-unique-elements.function.ts:12
Type Parameters
- T extends Primitive
Parameters
- array: T[]
Returns T[]
- Defined in common/src/get-array-unique-elements.function.ts:13
Type Parameters
- T extends object
- K extends string
Parameters
- array: T[]
- compareBy: number | symbol | K
Returns T[]

getArrayWithMovedItems

getArrayWithMovedItems<T>(array: T[], fromIndex: number, toIndex: number): T[]

- Defined in common/src/get-array-with-moved-items.function.ts:4
Type Parameters
- T
Parameters
- array: T[]
- fromIndex: number
- toIndex: number
Returns T[]

getArraysDifference

getArraysDifference(arrayA: string[], arrayB: string[]): string[]
getArraysDifference(arrayA: boolean[], arrayB: boolean[]): boolean[]
getArraysDifference(arrayA: number[], arrayB: number[]): number[]
getArraysDifference(arrayA: Primitive[], arrayB: Primitive[]): Primitive[]
getArraysDifference<T>(arrayA: T[], arrayB: T[], objectKey: string): T[]

- Defined in common/src/get-arrays-difference.function.ts:5
Parameters
- arrayA: string[]
- arrayB: string[]
Returns string[]
- Defined in common/src/get-arrays-difference.function.ts:6
Parameters
- arrayA: boolean[]
- arrayB: boolean[]
Returns boolean[]
- Defined in common/src/get-arrays-difference.function.ts:7
Parameters
- arrayA: number[]
- arrayB: number[]
Returns number[]
- Defined in common/src/get-arrays-difference.function.ts:8
Parameters
- arrayA: Primitive[]
- arrayB: Primitive[]
Returns Primitive[]
- Defined in common/src/get-arrays-difference.function.ts:9
Type Parameters
- T extends object
Parameters
- arrayA: T[]
- arrayB: T[]
- objectKey: string
Returns T[]

getClampedValue

getClampedValue(value: number, min: number, max: number): number | undefined

- Defined in common/src/get-clamped-value.function.ts:1
Parameters
- value: number
- min: number
- max: number
Returns number | undefined

getElementAllNestedChildren

getElementAllNestedChildren(element: Element): Element[]

- Defined in common/src/get-element-all-nested-children.function.ts:3
Parameters
- element: Element
Returns Element[]

getHslColorFromString

getHslColorFromString(inputString: string, saturation?: number, lightness?: number): HslColor

- Defined in common/src/get-hsl-color-from-string.function.ts:10
Parameters
- inputString: string
- saturation: number = DEFAULT_HSL_COLOR.s
- lightness: number = DEFAULT_HSL_COLOR.l
Returns HslColor

getIncrementedName

getIncrementedName(currentName: string, namesArray?: string[]): string

- Defined in common/src/get-incremented-name.function.ts:40
Parameters
- currentName: string
- namesArray: string[] = []
Returns string

getObjectPropertyComparator

getObjectPropertyComparator<T>(propertyName: string, getValueToCompare?: Converter): Comparator<T>

- Defined in common/src/get-object-property-comparator.function.ts:4
Type Parameters
- T extends object = object
Parameters
- propertyName: string
- Optional getValueToCompare: Converter
Returns Comparator<T>

getPagedArray

getPagedArray<T>(items: T[], perPageCount: number): T[][]

- Defined in common/src/get-paged-array.function.ts:4
Type Parameters
- T
Parameters
- items: T[]
- perPageCount: number
Returns T[][]

getRegExpPattern

getRegExpPattern(name: RegExpPatternName): RegExp | undefined

- Defined in common/src/get-reg-exp-pattern.function.ts:21
Parameters
- name: RegExpPatternName
Returns RegExp | undefined

getReversedArray

getReversedArray<T>(array: T[]): T[]

- Defined in common/src/get-reversed-array.function.ts:3
Type Parameters
- T
Parameters
- array: T[]
Returns T[]

getScreamingSnakeCasedString

getScreamingSnakeCasedString(input: Nullable<string>): Nullable<string>

- Defined in common/src/get-screaming-snake-cased-string.function.ts:5
Parameters
- input: Nullable<string>
Returns Nullable<string>

getShuffledArray

getShuffledArray<T>(array: T[]): T[]

- Defined in common/src/get-shuffled-array.function.ts:1
Type Parameters
- T
Parameters
- array: T[]
Returns T[]

getStringFromArrayBuffer

getStringFromArrayBuffer(buffer: Nullable<Uint8Array>, offset?: number): string | null

- Defined in common/src/get-string-from-array-buffer.function.ts:5
Parameters
- buffer: Nullable<Uint8Array>
- offset: number = 0
Returns string | null

getStringHash

getStringHash(inputString: string): number | undefined

- Defined in common/src/get-string-hash.function.ts:3
Parameters
- inputString: string
Returns number | undefined

getSubstringBetween

getSubstringBetween(source: string, __namedParameters: Options): string

- Defined in common/src/get-substring-between.function.ts:6
Parameters
- source: string
- __namedParameters: Options
Returns string

getUuid

getUuid(): Uuid

- Defined in common/src/get-uuid.function.ts:4
Returns Uuid

isEmpty

isEmpty(input: unknown): boolean

- Defined in common/src/is-empty.function.ts:10
Parameters
- input: unknown
Returns boolean

isEqual

isEqual(a: unknown, b: unknown): boolean

- Defined in common/src/is-equal.function.ts:5
Parameters
- a: unknown
- b: unknown
Returns boolean

isNil

isNil<T>(entity: Nullable<T>): entity is undefined | null

- Defined in common/src/is-nil.function.ts:3
Type Parameters
- T
Parameters
- entity: Nullable<T>
Returns entity is undefined | null

isNonEmptyObject

isNonEmptyObject(input: unknown): boolean

- Defined in common/src/is-non-empty-object.function.ts:4
Parameters
- input: unknown
Returns boolean

isNumber

isNumber(input: unknown): input is number

- Defined in common/src/is-number.function.ts:1
Parameters
- input: unknown
Returns input is number

isObject

isObject(input: unknown): input is object

- Defined in common/src/is-object.function.ts:1
Parameters
- input: unknown
Returns input is object

isObjectKeyUsed

isObjectKeyUsed<T, K>(object: T, key: Nullable<string>): object is WithProperty<T, K>

- Defined in common/src/is-object-key-used.function.ts:5
Type Parameters
- T extends object
- K extends string = string
Parameters
- object: T
- key: Nullable<string>
Returns object is WithProperty<T, K>

isString

isString(input: unknown): input is string

- Defined in common/src/is-string.function.ts:1
Parameters
- input: unknown
Returns input is string

isSymbol

isSymbol(input: unknown): input is symbol

- Defined in common/src/is-symbol.function.ts:1
Parameters
- input: unknown
Returns input is symbol

isUuid

isUuid(input: unknown): input is Uuid

- Defined in common/src/is-uuid.function.ts:4
Parameters
- input: unknown
Returns input is Uuid

mapArrayToKeyValueMap

mapArrayToKeyValueMap<T, Key>(array: T[], key: Key): Map<T[Key], T>

- Defined in common/src/map-array-to-key-value-map.function.ts:1
Type Parameters
- T extends object
- Key extends string | number | symbol
Parameters
- array: T[]
- key: Key
Returns Map<T[Key], T>

mergeArraysByProperty

mergeArraysByProperty<T>(property: string & keyof T, ...arrays: T[][]): T[]

- Defined in common/src/merge-arrays-by-property.function.ts:1
Type Parameters
- T
Parameters
- property: string & keyof T
- Rest ...arrays: T[][]
Returns T[]

nullIfEmpty

nullIfEmpty<T>(value: T): T | null

- Defined in common/src/null-if-empty.function.ts:3
Type Parameters
- T
Parameters
- value: T
Returns T | null

sortByProperty

sortByProperty<T>(array: T[], property: string | keyof T, comparator?: Comparator<unknown>): T[]
sortByProperty<T, K>(array: T[], property: string | keyof T, sortDirection?: K): T[]

- Defined in common/src/sort-by-property.function.ts:8
example
property = 'property.property...'

Type Parameters
- T extends object
Parameters
- array: T[]
- property: string | keyof T
- Optional comparator: Comparator<unknown>
Returns T[]
- Defined in common/src/sort-by-property.function.ts:9
Type Parameters
- T extends object
- K extends SortDirection = "ascending"
Parameters
- array: T[]
- property: string | keyof T
- Optional sortDirection: K
Returns T[]

stringFilterPredicate

stringFilterPredicate(targetValue: string, filterValue: string): boolean

- Defined in common/src/string-filter-predicate.function.ts:1
Parameters
- targetValue: string
- filterValue: string
Returns boolean

trimAllSpaces

trimAllSpaces(text: string): string

- Defined in common/src/trim-all-spaces.function.ts:3
Parameters
- text: string
Returns string

Index

Functions

Functions

blobToFile

Parameters

binary: Blob

fileName: string

Returns File

bytesToShortestUnit

Parameters

bytesCount: number

Returns string

downloadFile

Parameters

filename: string

data: string | Blob

Returns void

fileListToArray

Parameters

fileList: FileList

Returns File[]

getAbbreviatedCount

Parameters

count: Nullable<number>

Returns string | null

getArrayBufferFromString

Parameters

inputString: Nullable<string>

Returns Uint8Array | null

getArrayFirstElement

Type Parameters

T

Parameters

array: T[]

Returns T | undefined

getArrayLastElement

Type Parameters

T

Parameters

array: T[]

Returns T | undefined

getArrayUniqueElements

Parameters

array: []

Returns []

Parameters

array: number[]

Returns number[]

Parameters

array: boolean[]

Returns boolean[]

Parameters

array: string[]

Returns string[]

Type Parameters

T extends Primitive

Parameters

array: T[]

Returns T[]

Type Parameters

T extends object

K extends string

Parameters

array: T[]

compareBy: number | symbol | K

Returns T[]

getArrayWithMovedItems

Type Parameters

T

Parameters

array: T[]

fromIndex: number

toIndex: number

Returns T[]

getArraysDifference

Parameters

arrayA: string[]

arrayB: string[]

Returns string[]

Parameters