From b804285d5c8c070f0bdb751eebb932b5a5c0f4d6 Mon Sep 17 00:00:00 2001 From: Alexander Cerutti Date: Sat, 19 Jan 2019 16:39:05 +0100 Subject: [PATCH 1/2] Removed alpha version reference in the readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9db3c7..02c6f9d 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,12 @@ A browser detector. Because sometimes, there is no other way, and not even good The library is made to help to detect what browser your user has and gives you a convenient API to filter the users somehow depending on their browsers. -_Please, note that this is an alpha version. Check out the [1.x](https://github.com/lancedikson/bowser/tree/v1.x) branch for a stable version._ - **Changes of version 2.0** -The upcoming 2.0 version has drastically changed API. All available methods can be found in the `docs` folder from now on and on a webpage soon. + +The version 2.0 has drastically changed API. All available methods can be found in the `docs` folder from now on and on a webpage soon. + +_For legacy code, check out the [1.x](https://github.com/lancedikson/bowser/tree/v1.x) branch and install it through `npm install bowser@1.9.4`._ + # Use cases From c882d03ad43e437cdeeeb2251a4cb46012fcc2f3 Mon Sep 17 00:00:00 2001 From: Alexander Cerutti Date: Sat, 19 Jan 2019 16:42:58 +0100 Subject: [PATCH 2/2] Fixed broken indentation for typings --- index.d.ts | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/index.d.ts b/index.d.ts index 78108b9..49e797b 100644 --- a/index.d.ts +++ b/index.d.ts @@ -13,7 +13,7 @@ declare namespace Bowser { * @param {boolean} skipParsing */ - function getParser(UA: string, skipParsing?: boolean): Parser.Parser; + function getParser(UA: string, skipParsing?: boolean): Parser.Parser; /** * Creates a Parser instance and runs Parser.getResult immediately @@ -26,28 +26,28 @@ declare namespace Bowser { declare namespace Parser { class Parser { - constructor(UA: string, skipParsing?: boolean); + constructor(UA: string, skipParsing?: boolean); /** * Get parsed browser object * @return {BrowserDetails} Browser's details */ - getBrowser(): BrowserDetails; + getBrowser(): BrowserDetails; /** * Get browser's name * @return {String} Browser's name or an empty string */ - getBrowserName(): string; + getBrowserName(): string; /** * Get browser's version * @return {String} version of browser */ - getBrowserVersion(): string; + getBrowserVersion(): string; /** * Get OS @@ -60,7 +60,7 @@ declare namespace Parser { * // } */ - getOS(): OSDetails; + getOS(): OSDetails; /** * Get OS name @@ -68,49 +68,49 @@ declare namespace Parser { * @return {String} name of the OS — macOS, Windows, Linux, etc. */ - getOSName(toLowerCase?: boolean): string; + getOSName(toLowerCase?: boolean): string; /** * Get OS version * @return {String} full version with dots ('10.11.12', '5.6', etc) */ - getOSVersion(): string; + getOSVersion(): string; /** * Get parsed platform * @returns {PlatformDetails} */ - getPlatform(): PlatformDetails; + getPlatform(): PlatformDetails; /** * Get platform name * @param {boolean} toLowerCase */ - getPlatformType(toLowerCase?: boolean): string; + getPlatformType(toLowerCase?: boolean): string; /** * Get parsed engine * @returns {EngineDetails} */ - getEngine(): EngineDetails; + getEngine(): EngineDetails; /** * Get parsed result * @return {ParsedResult} */ - getResult(): ParsedResult; + getResult(): ParsedResult; /** * Get UserAgent string of current Parser instance * @return {String} User-Agent String of the current object */ - getUA(): string; + getUA(): string; /** * Is anything? Check if the browser is called "anything", @@ -119,41 +119,41 @@ declare namespace Parser { * @returns {Boolean} */ - is(anything: any): boolean; + is(anything: any): boolean; /** * Parse full information about the browser */ - parse(): void; + parse(): void; /** * Get parsed browser object * @returns {BrowserDetails} */ - parseBrowser(): BrowserDetails; + parseBrowser(): BrowserDetails; /** * Get parsed engine * @returns {EngineDetails} */ - parseEngine(): EngineDetails; + parseEngine(): EngineDetails; /** * Parse OS and save it to this.parsedResult.os * @returns {OSDetails} */ - parseOS(): OSDetails; + parseOS(): OSDetails; /** * Get parsed platform * @returns {PlatformDetails} */ - parsePlatform(): PlatformDetails; + parsePlatform(): PlatformDetails; /** * Check if parsed browser matches certain conditions @@ -174,7 +174,7 @@ declare namespace Parser { * if (browser.check({desktop: { chrome: '>118.01.1322' } })) */ - satisfies(checkTree: checkTree): boolean | undefined; + satisfies(checkTree: checkTree): boolean | undefined; /** * Check if any of the given values satifies `.is(anything)` @@ -182,7 +182,7 @@ declare namespace Parser { * @returns {boolean} true if at least one condition is satisfied, false otherwise. */ - some(anythings: string[]): boolean | undefined; + some(anythings: string[]): boolean | undefined; /** * Test a UA string for a regexp @@ -191,34 +191,34 @@ declare namespace Parser { */ test(regex: RegExp): boolean; - } + } interface ParsedResult { browser: BrowserDetails; os: OSDetails; platform: PlatformDetails; engine: EngineDetails; - } + } interface Details { name?: string; version?: string; - } + } interface OSDetails extends Details { versionName?: string; - } + } interface PlatformDetails { type?: string; vendor?: string; model?: string; - } + } type BrowserDetails = Details; type EngineDetails = Details; - interface checkTree { + interface checkTree { [key: string]: any; } }