Skip to content

Updated README removed param all true api #43

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
francisf merged 1 commit into from
Sep 11, 2020
Merged

Updated README removed param all true api #43

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
238 changes: 79 additions & 159 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,83 +69,59 @@ Fetches all available browsers.
{
'Windows':
{
'7':
'10':
[
{
browser: 'ie',
browser_version: 8.0,
},
{
browser: 'firefox',
browser_version: 2.0,
},
{
browser: 'chrome',
browser_version: 14.0,
} ...
],
'XP':
[
{
browser: 'ie',
browser_version: 7.0,
},
{
browser: 'firefox',
browser_version: 10.0,
},
{
browser: 'chrome',
browser_version: 14.0,
} ...
{
"browser": "chrome",
"browser_version": "83.0"
},
{
"browser": "chrome",
"browser_version": "84.0"
},
{
"browser": "chrome",
"browser_version": "85.0 beta"
},
{
"browser": "ie",
"browser_version": "11.0"
},
{
"browser": "edge",
"browser_version": "insider preview"
}...
],
},
'OS X':
{
'Snow Leopard':
'Catalina':
[
{
browser: 'firefox',
browser_version: 11.0,
},
{
browser: 'chrome',
browser_version: 14.0,
}, ...
],
'Lion':
[
{
browser: 'firefox',
browser_version: 11.0,
},
{
browser: 'chrome',
browser_version: 14.0,
} ...
{
"browser": "chrome",
"browser_version": "85.0 beta"
},
{
"browser": "edge",
"browser_version": "85.0 beta"
},
{
"browser": "safari",
"browser_version": "13.1"
},
{
"browser": "firefox",
"browser_version": "79.0"
},
{
"browser": "firefox",
"browser_version": "80.0 beta"
}...
],
},
'ios':
{
'4.0':
[
{
browser: "Mobile Safari",
browser_version: null,
devices: ["iPhone 4"],
}
],
'6.0':
[
{
browser: "Mobile Safari",
browser_version: null,
devices: ["iPhone 4S (6.0)", "iPhone 5", "iPad 3rd (6.0)"],
}
]
}...
},
}
```
```

A flat parameter can also be passed to get browsers in a flat structure

Expand All @@ -154,97 +130,41 @@ A flat parameter can also be passed to get browsers in a flat structure
### Output

```javascript
[
{
device: null,
os_version: "8",
os: "Windows",
browser_version: "5.1",
browser: "safari"
},
{
device: null,
os_version: "8",
os: "Windows",
browser_version: "16.0",
browser: "firefox"
},
{
device: null,
os_version: "8",
os: "Windows",
browser_version: "17.0",
browser: "firefox"
},
{
device: null,
os_version: "8",
os: "Windows",
browser_version: "18.0",
browser: "firefox"
},
{
device: null,
os_version: "8",
os: "Windows",
browser_version: "10.0",
browser: "ie"
}....
```

You can get beta/dev versions of browsers by using "all" parameter:

GET /browsers?all=true

### Output

```javascript
{
'Windows':
{
'XP':
[
{
browser: 'ie',
browser_version: 7.0,
},
{
browser: 'firefox',
browser_version: '28.0 beta',
},
{
browser: 'chrome',
browser_version: 14.0,
} ...
],
},
'OS X':
{
'Snow Leopard':
[
{
browser: 'firefox',
browser_version: 11.0,
},
{
browser: 'chrome',
browser_version: '27.0 beta',
}, ...
],
'Lion':
[
{
browser: 'firefox',
browser_version: 11.0,
},
{
browser: 'chrome',
browser_version: 14.0,
} ...
],
},
}
```
[
{
"os": "Windows",
"os_version": "10",
"browser": "chrome",
"device": null,
"browser_version": "84.0",
"real_mobile": null
},
{
"os": "Windows",
"os_version": "10",
"browser": "edge",
"device": null,
"browser_version": "85.0 beta",
"real_mobile": null
},
{
"os": "OS X",
"os_version": "Catalina",
"browser": "firefox",
"device": null,
"browser_version": "79.0",
"real_mobile": null
},
{
"os": "OS X",
"os_version": "Catalina",
"browser": "firefox",
"device": null,
"browser_version": "80.0 beta",
"real_mobile": null
}....
]
```

## Create a New Browser Worker
A browser worker is simply a new browser instance. A user can start multiple browser worker at a time. All browser workers when created are pushed in a queue and they run when their turn comes. We make sure that your browser worker starts running as soon as possible. Your testing time is calculated from the time when browser worker starts running.
Expand Down