Module: base

• logLevel

Ƭ AnyRecord: Record<PropertyKey, unknown>

Any js object with the record-like type

Ƭ CamelToKebabCase<S>: S extends `${infer T}${infer U}` ? `${T extends Capitalize<T> ? "-" : ""}${Lowercase<T>}${CamelToKebabCase<U>}` : S

Ƭ ClassType<T>: Function & { prototype: T }

Ƭ Constructable<T>: (...args: any) => T

• (...args)

Ƭ Constructor<T>: (...args: any) => T

• (...args)

Ƭ DeepMerge<T, U>: U extends AnyRecord ? T extends AnyRecord ? { [K in keyof U]: K extends keyof T ? DeepMerge<T[K], U[K]> : U[K] } & Omit<T, keyof U> : U : U

Recursively merge types by second type parameter properties substitution

Ƭ DeepPartial<T>: T extends AnyRecord ? { [K in keyof T]?: DeepPartial<T[K]> } : T

Recursively make record properties partial

Ƭ DeepRequired<T>: T extends AnyRecord ? { [K in keyof T]-?: DeepRequired<T[K]> } : T

Recursively make record properties required

Ƭ EmptyRecord: Record<PropertyKey, never>

Empty js object with the record-like type

Ƭ KeysToKebabCase<T>: { [K in keyof T as CamelToKebabCase<string & K>]: T[K] }

Transform keys in CamelCase into kebab-case

Ƭ Merge<T, U>: Omit<T, keyof U> & U

Shallow merge types by properties substitution

Ƭ ToDeepLowercase<T>: T extends AnyRecord ? { [K in string & keyof T as Lowercase<K>]: ToDeepLowercase<T[K]> } : T

Recursively toggle lowercase for the property names.

Ƭ ToLowercase<T>: { [Key in keyof T & string as Lowercase<Key>]: T[Key] }

Toggle lowercase for the property names, one level only.

Ƭ ToRecord<T>: { [K in keyof T]: T[K] }

Makes interface, class, etc, looks like Record<,> for the typescript type system

• Const logLevel: number

▸ abstractMethod(): never

This method is used to mark a method, which does not have implementation. By default, it throws exception that method is not implemented.

Throws

when invoked to indicate the method should be overridden.

never

▸ addWatermark(text, color, size): void

void

▸ convertCssToCanvas(size): number

Converts css size to canvas size

number

▸ createCopy<T>(obj, target?, param?): T

Create copy of the object

T

a copy of the input object

▸ deepArrayCopy<T>(array, lowercase?): T

Create a deep copy of array

T

a new instance of objects' array

▸ deepMergeObject(options, result?, lowercase?): any

Deep merge object method is the same as mergeObject method , except it supports nested objects.

any

▸ dummyMethod(): void

Does nothing. Intended to use as a default implementation of the optional method.

void

▸ enableRenderNativeResolution(enabled): void

Enables render using native resolution

void

▸ error(...args): void

Print in console error message. Passes on all parameters as passed.

void

▸ getBaseClassName(className): string

Return a base class name if it exists

string

▸ getClassType(className): ClassType<any>

Returns class constructor of the class, which is specified as string with full namespace.

ClassType<any>

constructor of the specified type

▸ getFullVersion(): string

Return the current version with full information

string

▸ getObjectClassName(obj): string

Return an object class name

string

▸ getPixelScale(): number

Returns pixel scale on current device

number

▸ getResource(moduleName, resourceName): any

Return a resource for the current module and resource name.

Deprecated

since 4.0. Use external storage instead.

any

▸ getVersion(): string

Return the current version

string

▸ implementsInterface(childClass, parentInterface): void

Declares "childClass" to implement "parentInterface"

void

▸ info(...args): void

Print in console info message. Passes on all parameters as passed.

void

▸ inherits(childClass, parentClass): void

Inherit the prototype methods from one constructor into another. Based on the Closure Library

Deprecated

since 4.0, use standard extends instead

void

▸ init(options): void

initialize modules

void

▸ instantiateClass(className, options?): any

Create instance of the class, which is specified as string with full namespace. This class must have default constructor

any

instance of the specified type

▸ interfaceCast(childInstance, parentInterface): any

Requests "childClass" for "parentInterface" support

Throws

if parentInterface is not defined

any

child class instance if "parentInterface" is implemented; null otherwise

▸ isInstanceOf<T>(instance, parentClass): instance is T

Check if instance is a parentClass or implements interface

instance is T

▸ isObjectEmpty(object): boolean

Check if object is empty (has no properties)

boolean

▸ isRenderNativeResolution(): boolean

Returns true if render native resolution

boolean

▸ log(...args): void

Print in console log message. Passes on all parameters as passed.

void

▸ mergeObjects<T, U>(options, result?, lowercase?, copyUndefinedOptions?): Merge<ToLowercase<ToRecord<T>>, ToRecord<U>>

This method is used to merge properties of two objects from options to results

Merge<ToLowercase<ToRecord<T>>, ToRecord<U>>

▸ mergeObjects<T, U>(options, result?, lowercase?, copyUndefinedOptions?): Merge<ToRecord<T>, ToRecord<U>>

This method is used to merge properties of two objects from options to results

Merge<ToRecord<T>, ToRecord<U>>

▸ parseFont(font): Object

Utility function to parse inline font string to json object. if the font string is not valid it will return an null object.

Object

props

props.fontweight font weight (normal, bold, etc.)

props.fontsize font size (ex: 12px)

props.fontfamily font family

props.fontlineheight line height

props.fontstyle font weight (normal, italic, etc.)

▸ processObjectProperties(object, recursive?): any

Process object in order to return a copy of the object with flat property names. This method doesn't change original object properties

any

▸ setClassName(currentClass, className): void

Sets name of the class, which can be retrieved using method getClassName() or toString()

void

▸ setResource(moduleName, resourceName, resource): void

Sets resources

Deprecated

since 4.0. Use external storage instead.

void

▸ shallowEqual(firstObject, secondObject): boolean

Make shallow comparison of two objects

boolean

▸ str2Function(str): Function

Create a function from a string containing the function

Deprecated

since 4.0

Function

func function created from string

▸ toLowerCase(object): Record<string, any>

Converts object to object with properties in lower case

Record<string, any>

object new object (!not modified)

▸ virtualMethod(): void

Specifies a virtual method.

by default, it generates log message when invoked to indicate the method should be overridden.

void

▸ warn(...args): void

Print in console warn message. Passes on all parameters as passed.

void