Options
All
  • Public
  • Public/Protected
  • All
Menu

@mixer/interactive-node

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

CompressionScheme

CompressionScheme: "none" | "gzip"

ControlKind

ControlKind: string

ETag

ETag: string
deprecated

etags are no longer used, you can always omit/ignore this

GridSize

GridSize: "large" | "medium" | "small"

IButtonInput

IButtonInput: IButtonMouseInput | IButtonKeyboardInput

JSONPrimitive

JSONPrimitive: boolean | string | number | null

MoveEventType

MoveEventType: "always" | "mousedown" | "never"

onReadyParams

onReadyParams: object

Type declaration

Variables

Const gridLayoutSizes

gridLayoutSizes: ReadonlyArray<IGridLayout> = Object.freeze(<IGridLayout[]>[{size: 'large',width: 80,height: 20,},{size: 'medium',width: 45,height: 25,},{size: 'small',width: 30,height: 40,},])

Offers constant information values to use in an application.

Functions

delay

  • delay(delay: number): Promise<void>

  • Returns a promise which is resolved with an optional value after the provided delay

    Parameters

    • delay: number

      The time in milliseconds to wait before resolving the promise

    Returns Promise<void>

merge

  • merge<T>(x: T, y: T): T

  • Merges the properties of two objects together, mutating the first object. Similar to lodash's merge.

    Type parameters

    • T

    Parameters

    • x: T
    • y: T

    Returns T

only

  • only<T, U>(cls: object, handler?: function): function

  • Returns a function that calls the wrapped function with only instances of the provided class, and throws them otherwise. This is meant to be used inside .catch blocks of promises.

    Imported from frontend2

    example

    // Suppress an error return foo.catch(only(AlreadyExistsError)); // Handle a error return foo.catch(only(AdapterResponseError, err => alert(err.toLocaleString())));

    Type parameters

    • T: Error

    • U

    Parameters

    • cls: object
    • Default value handler: function = () => null
        • (err: T): U

        • Parameters

          • err: T

          Returns U

    Returns function

      • (err: any): U

      • Parameters

        • err: any

        Returns U

resolveOn

  • resolveOn(emitter: EventEmitter, event: string, timeout?: number): Promise<any>

  • Returns a promise that's resolved when an event is emitted on the EventEmitter.

    para

    {number} timeout used to prevent memory leaks

    Parameters

    • emitter: EventEmitter
    • event: string
    • Default value timeout: number = 120 * 1000

    Returns Promise<any>

setWebSocket

  • setWebSocket(ws: any): void

  • This allows you to specify which WebSocket implementation your environment is using. You do not need to do this in Browser environments.

    example

    Interactive.setWebsocket(require('ws'));

    Parameters

    • ws: any

    Returns void

timeout

  • timeout(message: string, delay: number): Promise<void>

  • Return a promise which is rejected with a TimeoutError after the provided delay.

    Parameters

    • message: string
    • delay: number

    Returns Promise<void>

Generated using TypeDoc