@unlimited/smartapp-bridge

Index

Enumerations

Classes

Type aliases

Variables

Functions

Type aliases

Bridge

Bridge: { disableLogs: () => void; disableRenameParams: () => void; enableLogs: () => void; enableRenameParams: () => void; log?: undefined | ((data: string | object) => void); onReceive: (callback: EventEmitterCallback) => void; sendBotEvent: (event: BridgeSendBotEventParams) => Promise<EmitterEventPayload>; sendClientEvent: (event: BridgeSendClientEventParams) => Promise<EmitterEventPayload> }

Type declaration

Readonly disableLogs: () => void
- - (): void
  - Returns void
Readonly disableRenameParams: () => void
- - (): void
  - Returns void
Readonly enableLogs: () => void
- - (): void
  - Returns void
Readonly enableRenameParams: () => void
- - (): void
  - Returns void
Optional Readonly log?: undefined | ((data: string | object) => void)
Readonly onReceive: (callback: EventEmitterCallback) => void
- - (callback: EventEmitterCallback): void
  - Parameters
    - callback: EventEmitterCallback
    Returns void
Readonly sendBotEvent: (event: BridgeSendBotEventParams) => Promise<EmitterEventPayload>
- - (event: BridgeSendBotEventParams): Promise<EmitterEventPayload>
  - Parameters
    - event: BridgeSendBotEventParams
    Returns Promise<EmitterEventPayload>
Readonly sendClientEvent: (event: BridgeSendClientEventParams) => Promise<EmitterEventPayload>
- - (event: BridgeSendClientEventParams): Promise<EmitterEventPayload>
  - Parameters
    - event: BridgeSendClientEventParams
    Returns Promise<EmitterEventPayload>

BridgeSendBotEventParams

BridgeSendBotEventParams: BridgeSendClientEventParams & { files?: any; guaranteed_delivery_required?: boolean | undefined }

BridgeSendClientEventParams

BridgeSendClientEventParams: { method: string; params: object | undefined; timeout?: undefined | number }

Type declaration

Readonly method: string
Readonly params: object | undefined
Optional Readonly timeout?: undefined | number

BridgeSendEventParams

BridgeSendEventParams: BridgeSendClientEventParams & BridgeSendBotEventParams & { handler: HANDLER }

EmitterEventPayload

EmitterEventPayload: { files?: undefined | object; handler: HANDLER; payload: object | undefined; ref: string | undefined; type: string }

Type declaration

Optional Readonly files?: undefined | object
Readonly handler: HANDLER
Readonly payload: object | undefined
Readonly ref: string | undefined
Readonly type: string

EmitterEventType

EmitterEventType: EVENT_TYPE | string

EventEmitterCallback

EventEmitterCallback: (event: EmitterEventPayload) => void

Type declaration

- (event: EmitterEventPayload): void
- Parameters
  - event: EmitterEventPayload
  Returns void

Variables

Const LIB_VERSION

LIB_VERSION: "1.2.1" = "1.2.1"

Const RESPONSE_TIMEOUT

RESPONSE_TIMEOUT: 30000 = 30000

Const WEB_COMMAND_TYPE

WEB_COMMAND_TYPE: "smartapp" = "smartapp"

Const WEB_COMMAND_TYPE_RPC

WEB_COMMAND_TYPE_RPC: "smartapp_rpc" = "smartapp_rpc"

Const WEB_COMMAND_TYPE_RPC_LOGS

WEB_COMMAND_TYPE_RPC_LOGS: "smartAppLogs" = "smartAppLogs"

Functions

Const camelCaseToSnakeCase

camelCaseToSnakeCase(data: any): any

- Defined in src/lib/case.ts:19
Parameters
- data: any
Returns any

Const detectPlatformByUserAgent

detectPlatformByUserAgent(): PLATFORM

- Defined in src/lib/platformDetector.ts:12
Returns PLATFORM

Const getBridge

getBridge(): Bridge | null

- Defined in src/index.ts:9
Returns Bridge | null

Const getPlatform

getPlatform(): PLATFORM

- Defined in src/lib/platformDetector.ts:36
Get platform. Detection based on GET param platform or user agent.
```
const platform = getPlatform();

// => 'web' | 'ios' | 'android'
```
Returns PLATFORM

Const getPlatformByGetParam

getPlatformByGetParam(): PLATFORM

- Defined in src/lib/platformDetector.ts:3
Returns PLATFORM

Const isUuid

isUuid(value: string): boolean

- Defined in src/lib/case.ts:5
Parameters
- value: string
Returns boolean

Const snakeCaseToCamelCase

snakeCaseToCamelCase(data: any): any

- Defined in src/lib/case.ts:9
Parameters
- data: any
Returns any

Index

Enumerations

Classes

Type aliases

Variables

Functions

Type aliases

Bridge

Type declaration

Readonly disableLogs: () => void

Returns void

Readonly disableRenameParams: () => void

Returns void

Readonly enableLogs: () => void

Returns void

Readonly enableRenameParams: () => void

Returns void

Optional Readonly log?: undefined | ((data: string | object) => void)

Readonly onReceive: (callback: EventEmitterCallback) => void

Parameters

callback: EventEmitterCallback

Returns void

Readonly sendBotEvent: (event: BridgeSendBotEventParams) => Promise<EmitterEventPayload>

Parameters

event: BridgeSendBotEventParams

Returns Promise<EmitterEventPayload>

Readonly sendClientEvent: (event: BridgeSendClientEventParams) => Promise<EmitterEventPayload>

Parameters

event: BridgeSendClientEventParams

Returns Promise<EmitterEventPayload>

BridgeSendBotEventParams

BridgeSendClientEventParams

Type declaration

Readonly method: string

Readonly params: object | undefined

Optional Readonly timeout?: undefined | number

BridgeSendEventParams

EmitterEventPayload

Type declaration

Optional Readonly files?: undefined | object

Readonly handler: HANDLER

Readonly payload: object | undefined

Readonly ref: string | undefined

Readonly type: string

EmitterEventType

EventEmitterCallback

Type declaration

Parameters

event: EmitterEventPayload

Returns void

Variables

Const LIB_VERSION

Const RESPONSE_TIMEOUT

Const WEB_COMMAND_TYPE

Const WEB_COMMAND_TYPE_RPC

Const WEB_COMMAND_TYPE_RPC_LOGS

Functions

Const camelCaseToSnakeCase

Parameters

data: any

Returns any

Const detectPlatformByUserAgent

Returns PLATFORM

Const getBridge

Returns Bridge | null

Const getPlatform

Returns PLATFORM

Const getPlatformByGetParam

Returns PLATFORM

Const isUuid

Parameters

value: string

Returns boolean

Const snakeCaseToCamelCase

Parameters

data: any

Returns any