Class BackendUtilities

Hierarchy

Utilities
- BackendUtilities

Index

Properties

performanceNow

Accessors

namespace

Methods

Properties

performanceNow

performanceNow: now = PerformanceNow

Accessors

namespace

get namespace(): string

Inherited from Utilities.namespace
- Defined in abstract/utils.ts:12
Returns the current UUID representing the namespace of the package

Returns string

Methods

buildFullUrl

buildFullUrl(action: string, params: string, baseUrl: string): string

Inherited from Utilities.buildFullUrl
- Defined in abstract/utils.ts:54
Builds the url that'll trigger desired action

Parameters
- action: string
- params: string
- baseUrl: string
Returns string

callBetterTouchTool

callBetterTouchTool(action: string, data: Types.BttPayload, config: AppConfig, translate?: boolean): Promise<CallResult>

Overrides Utilities.callBetterTouchTool
- Defined in backend/utils.ts:38
Sends a request to real BTT built in webserver with given data translated as GET query params

Parameters
- action: string
- data: Types.BttPayload
- config: AppConfig
- Default value translate: boolean = true
Returns Promise<CallResult>

deleteTrigger

deleteTrigger(uuid: string): void

Overrides Utilities.deleteTrigger
- Defined in backend/utils.ts:16
Parameters
- uuid: string
Returns void

fetch

fetch(url: string, options?: any): Promise<any>

Overrides Utilities.fetch
- Defined in backend/utils.ts:11
Parameters
- url: string
- Optional options: any
Returns Promise<any>

generateUuidForString

generateUuidForString(text: string, namespace?: string): string

Inherited from Utilities.generateUuidForString
- Defined in abstract/utils.ts:147
Takes a namespace as a parameter and a text, to generate an UUID (uuidv5)

Parameters
- text: string
- Default value namespace: string = NAMESPACE
Returns string

getBaseUrl

getBaseUrl(config: Partial<AppConfig>): string

Inherited from Utilities.getBaseUrl
- Defined in abstract/utils.ts:137
Returns a base url for the BTT webserver endpoint

Parameters
- config: Partial<AppConfig>
Returns string

getMdlsName

getMdlsName(applicationPath: string): string

Overrides Utilities.getMdlsName
- Defined in backend/utils.ts:30
Parameters
- applicationPath: string
Returns string

getNodeBinaryPath

getNodeBinaryPath(): string

Overrides Utilities.getNodeBinaryPath
- Defined in backend/utils.ts:20
Returns string

getUrl

getUrl(config: Partial<AppConfig>): string

Inherited from Utilities.getUrl
- Defined in abstract/utils.ts:42
Returns a base url for the BTT webserver endpoint

Parameters
- config: Partial<AppConfig>
Returns string

keyToBttNotation

keyToBttNotation(key: string): string

Inherited from Utilities.keyToBttNotation
- Defined in abstract/utils.ts:116
Maps given string to btt JSON key notation

example

'triggerName' => 'BTTTriggerName'

Parameters
- key: string
Returns string

mapClassNameToMethodName

mapClassNameToMethodName(theClass: Class<BaseAction>): string

Inherited from Utilities.mapClassNameToMethodName
- Defined in abstract/utils.ts:156
Parses given class name to simplified notation

example

Class AShowHUD { } => showhud

Parameters
- theClass: Class<BaseAction>
Returns string

params

params(data: Record<string, string>, sharedKey?: string, sharedSecret?: string): string

Inherited from Utilities.params
- Defined in abstract/utils.ts:62
Parses given list of params (key-value object) and converts it to query parameters

Parameters
- data: Record<string, string>
- Optional sharedKey: string
- Optional sharedSecret: string
Returns string

simpleCase

simpleCase(value: string): string

Inherited from Utilities.simpleCase
- Defined in abstract/utils.ts:127
Parses given string to simplified lower case

Parameters
- value: string
Returns string

translateObjectKeysToBttNotation

translateObjectKeysToBttNotation(object: Partial<Types.AppPayload> | Partial<Types.BttPayload>): object

Inherited from Utilities.translateObjectKeysToBttNotation
- Defined in abstract/utils.ts:85
Maps each key in the passed object to btt notation (BTTWhateverPassed)

Parameters
- object: Partial<Types.AppPayload> | Partial<Types.BttPayload>
Returns object