mirror of
https://github.com/lancedikson/bowser
synced 2024-10-27 20:34:22 +00:00
docs: update Typescript definition file (#500)
This commit is contained in:
parent
69bc6c2dbf
commit
29222b2fcf
51
index.d.ts
vendored
51
index.d.ts
vendored
@ -34,6 +34,14 @@ declare namespace Bowser {
|
|||||||
interface Parser {
|
interface Parser {
|
||||||
constructor(UA: string, skipParsing?: boolean): Parser.Parser;
|
constructor(UA: string, skipParsing?: boolean): Parser.Parser;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the version is equals the browser version
|
||||||
|
* @param version The string to compare with the browser version
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
|
||||||
|
compareVersion(version: string): boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get parsed browser object
|
* Get parsed browser object
|
||||||
* @return {BrowserDetails} Browser's details
|
* @return {BrowserDetails} Browser's details
|
||||||
@ -135,6 +143,39 @@ declare namespace Bowser {
|
|||||||
|
|
||||||
is(anything: any): boolean;
|
is(anything: any): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the browser name equals the passed string
|
||||||
|
* @param browserName The string to compare with the browser name
|
||||||
|
* @param [includingAlias=false] The flag showing whether alias will be included into comparison
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
|
||||||
|
isBrowser(browserName: string, includingAlias?: boolean): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the engine name equals the passed string
|
||||||
|
* @param engineName The string to compare with the engine name
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
|
||||||
|
isEngine(engineName: string): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the OS name equals the passed string
|
||||||
|
* @param OSName The string to compare with the OS name
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
|
||||||
|
isOS(OSName: string): boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the platform name equals the passed string
|
||||||
|
* @param platformName The string to compare with the platform name
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
|
||||||
|
isPlatform(platformName: string): boolean;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse full information about the browser
|
* Parse full information about the browser
|
||||||
* @returns {Parser.Parser}
|
* @returns {Parser.Parser}
|
||||||
@ -191,16 +232,6 @@ declare namespace Bowser {
|
|||||||
|
|
||||||
satisfies(checkTree: checkTree): boolean | undefined;
|
satisfies(checkTree: checkTree): boolean | undefined;
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if the browser name equals the passed string
|
|
||||||
* @param browserName The string to compare with the browser name
|
|
||||||
* @param [includingAlias=false] The flag showing whether alias will be included into comparison
|
|
||||||
* @returns {boolean}
|
|
||||||
*/
|
|
||||||
|
|
||||||
|
|
||||||
isBrowser(browserName: string, includingAlias?: boolean): boolean;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Check if any of the given values satifies `.is(anything)`
|
* Check if any of the given values satifies `.is(anything)`
|
||||||
* @param {string[]} anythings
|
* @param {string[]} anythings
|
||||||
|
Loading…
Reference in New Issue
Block a user