Class RokuClient

Hierarchy

RokuClient

Index

Constructors

Properties

default? defaultRokuPort? rokus

Accessors

Methods

#delayRequest #getIP #getPort #request back down forward home info instantReplay left play rewind right select sendLetter setDefault sleep stop up

Constructors

constructor

new RokuClient(options?): RokuClient
Parameters
- Optional options: RokuClientOptions
Returns RokuClient
- Defined in index.ts:10

Properties

`Private` `Optional` default

default?: string

`Private` `Optional` defaultRokuPort

defaultRokuPort?: number

`Private` rokus

rokus: Map<string, string> = ...

Accessors

cache

get cache(): {
    add: ((name, ip) => {
        message: string;
        status: boolean;
    });
    clear: (() => {
        message: string;
        status: boolean;
    });
    get: ((name) => null | string);
    list: (() => Map<string, string>);
    remove: ((name) => {
        message: string;
        status: boolean;
    });
    size: (() => number);
}
Returns {
    add: ((name, ip) => {
        message: string;
        status: boolean;
    });
    clear: (() => {
        message: string;
        status: boolean;
    });
    get: ((name) => null | string);
    list: (() => Map<string, string>);
    remove: ((name) => {
        message: string;
        status: boolean;
    });
    size: (() => number);
}
- add: ((name, ip) => {
  message: string;
  status: boolean;
  })
  - - (name, ip): {
      message: string;
      status: boolean;
      }
    - Parameters
      
      name: string
      
      ip: string
      Returns {
      message: string;
      status: boolean;
      }
      - message: string
      - status: boolean
- clear: (() => {
  message: string;
  status: boolean;
  })
  - - (): {
      message: string;
      status: boolean;
      }
    - Returns {
      message: string;
      status: boolean;
      }
      - message: string
      - status: boolean
- get: ((name) => null | string)
  - - (name): null | string
    - Parameters
      
      name: string
      Returns null | string
- list: (() => Map<string, string>)
  - - (): Map<string, string>
    - Returns Map<string, string>
- remove: ((name) => {
  message: string;
  status: boolean;
  })
  - - (name): {
      message: string;
      status: boolean;
      }
    - Parameters
      
      name: string
      Returns {
      message: string;
      status: boolean;
      }
      - message: string
      - status: boolean
- size: (() => number)
  - - (): number
    - Returns number
- Defined in index.ts:35

Methods

`Private` #delayRequest

#delayRequest(roku, action, delay?): Promise<any>
Parameters
- roku: undefined | string
- action: string
- Optional delay: number
Returns Promise<any>
- Defined in index.ts:150

`Private` #getIP

#getIP(str?): string
Parameters
- str: string = ...
Returns string
- Defined in index.ts:92

`Private` #getPort

#getPort(): number
Returns number
- Defined in index.ts:87

`Private` #request

#request(ip, action): Promise<any>
Parameters
- ip: undefined | string
- action: string
Returns Promise<any>
- Defined in index.ts:141

back

back(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:117

down

down(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:138

forward

forward(roku?, delay?): Promise<any>
Parameters
- Optional roku: string
- Optional delay: number
Returns Promise<any>
- Defined in index.ts:111

home

home(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:108

info

info(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:102

instantReplay

instantReplay(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:105

left

left(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:129

play

play(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:120

rewind

rewind(roku?, delay?): Promise<any>
Parameters
- Optional roku: string
- Optional delay: number
Returns Promise<any>
- Defined in index.ts:114

right

right(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:132

select

select(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:126

sendLetter

sendLetter(roku?, letter?): Promise<any>
Parameters
- Optional roku: string
- Optional letter: string
Returns Promise<any>
- Defined in index.ts:99

setDefault

setDefault(name?): RokuClient
Parameters
- Optional name: string
Returns RokuClient
- Defined in index.ts:26

`Private` sleep

sleep(ms): Promise<unknown>
Parameters
- ms: number
Returns Promise<unknown>
- Defined in index.ts:96

stop

stop(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:123

up

up(roku?): Promise<any>
Parameters
- Optional roku: string
Returns Promise<any>
- Defined in index.ts:135

Generated using TypeDoc