Skip to content

Add better device-info jsdoc block #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TwitchBronBron merged 1 commit into from
Nov 13, 2023
Merged

Add better device-info jsdoc block #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/RokuDeploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1216,8 +1216,17 @@ export interface TakeScreenshotOptions {
}

export interface GetDeviceInfoOptions {
/**
* The hostname or IP address to use for the device-info URL
*/
host: string;
/**
* The port to use to send the device-info request (defaults to the standard 8060 ECP port)
*/
remotePort?: number;
/**
* The number of milliseconds at which point this request should timeout and return a rejected promise
*/
timeout?: number;
/**
* Should the device-info be enhanced by camel-casing the property names and converting boolean strings to booleans and number strings to numbers?
Expand Down