File Explorer

1// Type definitions for Bowser v22// Project: https://github.com/bowser-js/bowser3// Definitions by: Alexander P. Cerutti <https://github.com/alexandercerutti>,4 5export = Bowser;6export as namespace Bowser;7 8declare namespace Bowser {9  /**10   * User-Agent Client Hints data structure11   * @see https://developer.mozilla.org/en-US/docs/Web/API/NavigatorUAData12   */13  interface ClientHints {14    brands?: Array<{ brand: string; version: string }>;15    mobile?: boolean;16    platform?: string;17    platformVersion?: string;18    architecture?: string;19    model?: string;20    wow64?: boolean;21  }22 23  /**24   * Creates a Parser instance25   * @param {string} UA - User agent string26   * @param {boolean | ClientHints} skipParsingOrHints - Either skip parsing flag or Client Hints27   * @param {ClientHints} clientHints - User-Agent Client Hints data28   */29  function getParser(UA: string, skipParsing?: boolean): Parser.Parser;30  function getParser(UA: string, clientHints?: ClientHints): Parser.Parser;31  function getParser(UA: string, skipParsing?: boolean, clientHints?: ClientHints): Parser.Parser;32 33  /**34   * Creates a Parser instance and runs Parser.getResult immediately35   * @param UA - User agent string36   * @param clientHints - User-Agent Client Hints data37   * @returns {Parser.ParsedResult}38   */39  function parse(UA: string, clientHints?: ClientHints): Parser.ParsedResult;40 41  /**42   * Constants exposed via bowser getters43   */44  const BROWSER_MAP: Record<string, string>;45  const ENGINE_MAP: Record<string, string>;46  const OS_MAP: Record<string, string>;47  const PLATFORMS_MAP: Record<string, string>;48 49  namespace Parser {50    interface Parser {51      constructor(UA: string, skipParsing?: boolean): Parser.Parser;52      constructor(UA: string, clientHints?: ClientHints): Parser.Parser;53      constructor(UA: string, skipParsing?: boolean, clientHints?: ClientHints): Parser.Parser;54 55      /**56       * Get Client Hints data57       * @return {ClientHints|null}58       */59      getHints(): ClientHints | null;60 61      /**62       * Check if a brand exists in Client Hints brands array63       * @param {string} brandName The brand name to check for64       * @return {boolean}65       */66      hasBrand(brandName: string): boolean;67 68      /**69       * Get brand version from Client Hints70       * @param {string} brandName The brand name to get version for71       * @return {string|undefined}72       */73      getBrandVersion(brandName: string): string | undefined;74 75      /**76       * Check if the version is equals the browser version77       * @param version The string to compare with the browser version78       * @returns {boolean}79       */80 81      compareVersion(version: string): boolean;82 83      /**84       * Get parsed browser object85       * @return {BrowserDetails} Browser's details86       */87 88      getBrowser(): BrowserDetails;89 90      /**91       * Get browser's name92       * @param {Boolean} [toLowerCase] return lower-cased value93       * @return {String} Browser's name or an empty string94       */95 96      getBrowserName(toLowerCase?: boolean): string;97 98      /**99       * Get browser's version100       * @return {String} version of browser101       */102 103      getBrowserVersion(): string | undefined;104 105      /**106       * Get OS107       * @return {OSDetails} - OS Details108       *109       * @example110       * this.getOS(); // {111       * //   name: 'macOS',112       * //   version: '10.11.12',113       * // }114       */115 116      getOS(): OSDetails;117 118      /**119       * Get OS name120       * @param {Boolean} [toLowerCase] return lower-cased value121       * @return {String} name of the OS — macOS, Windows, Linux, etc.122       */123 124      getOSName(toLowerCase?: boolean): string;125 126      /**127       * Get OS version128       * @return {String} full version with dots ('10.11.12', '5.6', etc)129       */130 131      getOSVersion(): string;132 133      /**134       * Get parsed platform135       * @returns {PlatformDetails}136       */137 138      getPlatform(): PlatformDetails;139 140      /**141       * Get platform name142       * @param {boolean} toLowerCase143       */144 145      getPlatformType(toLowerCase?: boolean): string;146 147      /**148       * Get parsed engine149       * @returns {EngineDetails}150       */151 152      getEngine(): EngineDetails;153 154      /**155       * Get parsed engine's name156       * @returns {String} Engine's name or an empty string157       */158 159      getEngineName(): string;160 161      /**162       * Get parsed result163       * @return {ParsedResult}164       */165 166      getResult(): ParsedResult;167 168      /**169       * Get UserAgent string of current Parser instance170       * @return {String} User-Agent String of the current <Parser> object171       */172 173      getUA(): string;174 175      /**176       * Is anything? Check if the browser is called "anything",177       * the OS called "anything" or the platform called "anything"178       * @param {String} anything179       * @param [includingAlias=false] The flag showing whether alias will be included into comparison180       * @returns {Boolean}181       */182 183      is(anything: any, includingAlias?: boolean): boolean;184 185      /**186       * Check if the browser name equals the passed string187       * @param browserName The string to compare with the browser name188       * @param [includingAlias=false] The flag showing whether alias will be included into comparison189       * @returns {boolean}190       */191 192      isBrowser(browserName: string, includingAlias?: boolean): boolean;193 194      /**195       * Check if the engine name equals the passed string196       * @param engineName The string to compare with the engine name197       * @returns {boolean}198       */199 200      isEngine(engineName: string): boolean;201 202      /**203       * Check if the OS name equals the passed string204       * @param OSName The string to compare with the OS name205       * @returns {boolean}206       */207 208      isOS(OSName: string): boolean;209 210      /**211       * Check if the platform name equals the passed string212       * @param platformName The string to compare with the platform name213       * @returns {boolean}214       */215 216      isPlatform(platformName: string): boolean;217 218      /**219       * Parse full information about the browser220       * @returns {Parser.Parser}221       */222 223      parse(): Parser.Parser;224 225      /**226       * Get parsed browser object227       * @returns {BrowserDetails}228       */229 230      parseBrowser(): BrowserDetails;231 232      /**233       * Get parsed engine234       * @returns {EngineDetails}235       */236 237      parseEngine(): EngineDetails;238 239      /**240       * Parse OS and save it to this.parsedResult.os241       * @returns {OSDetails}242       */243 244      parseOS(): OSDetails;245 246      /**247       * Get parsed platform248       * @returns {PlatformDetails}249       */250 251      parsePlatform(): PlatformDetails;252 253      /**254       * Check if parsed browser matches certain conditions255       *256       * @param {checkTree} checkTree It's one or two layered object,257       * which can include a platform or an OS on the first layer258       * and should have browsers specs on the bottom-laying layer259       *260       * @returns {Boolean|undefined} Whether the browser satisfies the set conditions or not.261       * Returns `undefined` when the browser is no described in the checkTree object.262       *263       * @example264       * const browser = new Bowser(UA);265       * if (browser.check({chrome: '>118.01.1322' }))266       * // or with os267       * if (browser.check({windows: { chrome: '>118.01.1322' } }))268       * // or with platforms269       * if (browser.check({desktop: { chrome: '>118.01.1322' } }))270       */271 272      satisfies(checkTree: checkTree): boolean | undefined;273 274      /**275       * Check if the browser name equals the passed string276       * @param {string} browserName The string to compare with the browser name277       * @param [includingAlias=false] The flag showing whether alias will be included into comparison278       * @returns {boolean}279       */280 281      isBrowser(browserName: string, includingAlias?: boolean): boolean;282 283      /**284       * Check if the engine name equals the passed string285       * @param {string} engineName The string to compare with the engine name286       * @returns {boolean}287       */288 289      isEngine(engineName: string): boolean;290 291      /**292       * Check if the platform type equals the passed string293       * @param {string} platformType The string to compare with the platform type294       * @returns {boolean}295       */296 297      isPlatform(platformType: string): boolean;298 299      /**300       * Check if the OS name equals the passed string301       * @param {string} osName The string to compare with the OS name302       * @returns {boolean}303       */304 305      isOS(osName: string): boolean;306 307      /**308       * Check if any of the given values satisfies `.is(anything)`309       * @param {string[]} anythings310       * @returns {boolean} true if at least one condition is satisfied, false otherwise.311       */312 313      some(anythings: string[]): boolean | undefined;314 315      /**316       * Test a UA string for a regexp317       * @param regex318       * @returns {boolean} true if the regex matches the UA, false otherwise.319       */320 321      test(regex: RegExp): boolean;322    }323 324    interface ParsedResult {325      browser: BrowserDetails;326      os: OSDetails;327      platform: PlatformDetails;328      engine: EngineDetails;329    }330 331    interface Details {332      name?: string;333      version?: string;334    }335 336    interface OSDetails extends Details {337      versionName?: string;338    }339 340    interface PlatformDetails {341      type?: string;342      vendor?: string;343      model?: string;344    }345 346    type BrowserDetails = Details;347    type EngineDetails = Details;348 349    interface checkTree {350      [key: string]: any;351    }352  }353}354