@types/platform - npm Package Compare versions

Comparing version 1.3.2 to 1.3.3

platform/index.d.ts

 // Type definitions for Platform 1.3
 // Project: https://github.com/bestiejs/platform.js
 // Definitions by: Jake Hickman <https://github.com/JakeH>
+//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-declare interface Platform {
+export as namespace platform;
+
+/**
+ * The platform object.
+ */
+interface Platform {
+    /**
+     * The platform description.
+     */
     description?: string;
+    /**
+     * The name of the browser's layout engine.
+     *
+     * The list of common layout engines include:
+     * "Blink", "EdgeHTML", "Gecko", "Trident" and "WebKit"
+     */
     layout?: string;
+    /**
+     * The name of the product's manufacturer.
+     *
+     * The list of manufacturers include:
+     * "Apple", "Archos", "Amazon", "Asus", "Barnes & Noble", "BlackBerry",
+     * "Google", "HP", "HTC", "LG", "Microsoft", "Motorola", "Nintendo",
+     * "Nokia", "Samsung" and "Sony"
+     */
     manufacturer?: string;
+    /**
+     * The name of the browser/environment.
+     *
+     * The list of common browser names include:
+     * "Chrome", "Electron", "Firefox", "Firefox for iOS", "IE",
+     * "Microsoft Edge", "PhantomJS", "Safari", "SeaMonkey", "Silk",
+     * "Opera Mini" and "Opera"
+     *
+     * Mobile versions of some browsers have "Mobile" appended to their name:
+     * eg. "Chrome Mobile", "Firefox Mobile", "IE Mobile" and "Opera Mobile"
+     */
     name?: string;
+    /**
+     * The alpha/beta release indicator.
+     */
     prerelease?: string;
+    /**
+     * The name of the product hosting the browser.
+     *
+     * The list of common products include:
+     *
+     * "BlackBerry", "Galaxy S4", "Lumia", "iPad", "iPod", "iPhone", "Kindle",
+     * "Kindle Fire", "Nexus", "Nook", "PlayBook", "TouchPad" and "Transformer"
+     */
     product?: string;
+    /**
+     * The browser's user agent string.
+     */
     ua?: string;
+    /**
+     * The version of the OS.
+     */
     version?: string;
-    os?: {
-        architecture?: number;
-        family?: string;
-        version?: string;
-        toString(): string;
-    };
-    parse(ua: string): Platform;
+    /**
+     * The name of the operating system.
+     */
+    os?: OperatingSystem;
+    /**
+     * Creates a new platform object.
+     * @param [ua=navigator.userAgent] The user agent string or
+     *  context object.
+     */
+    parse(ua?: object | string): Platform;
+    /**
+     * Returns `platform.description` when the platform object is coerced to a string.
+     */
     toString(): string;
 }
 
-declare var platform: Platform;
-
-declare module "platform" {
-    export = platform;
+interface OperatingSystem {
+    /**
+     * The CPU architecture the OS is built for.
+     */
+    architecture?: number;
+    /**
+     * The family of the OS.
+     *
+     * Common values include:
+     * "Windows", "Windows Server 2008 R2 / 7", "Windows Server 2008 / Vista",
+     * "Windows XP", "OS X", "Linux", "Ubuntu", "Debian", "Fedora", "Red Hat",
+     * "SuSE", "Android", "iOS" and "Windows Phone"
+     */
+    family?: string;
+    /**
+     * The version of the OS.
+     */
+    version?: string;
+    /**
+     * Returns the OS string.
+     */
+    toString(): string;
 }
 
+declare const platform: Platform;
+
+export = platform;

platform/package.json

 {
     "name": "@types/platform",
-    "version": "1.3.2",
+    "version": "1.3.3",
     "description": "TypeScript definitions for Platform",
@@ -11,14 +11,20 @@ "license": "MIT",
             "githubUsername": "JakeH"
+        },
+        {
+            "name": "Piotr Błażejewicz",
+            "url": "https://github.com/peterblazejewicz",
+            "githubUsername": "peterblazejewicz"
         }
     ],
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/platform"
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "2aaccf83ffb9eeab39450fb56e3a6545dd7eaa17283e3d560a31e77c92eb7194",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "3f298cc452aa0d73fdc1d7fdf6f6144a673a6ddf5de840cd0b0a99bd45f77451",
+    "typeScriptVersion": "3.1"
 }

platform/README.md

@@ -5,13 +5,13 @@ # Installation
 # Summary
-This package contains type definitions for Platform ( https://github.com/bestiejs/platform.js ).
+This package contains type definitions for Platform (https://github.com/bestiejs/platform.js).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/platform
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/platform.
 
-Additional Details
- * Last updated: Fri, 08 Feb 2019 00:24:23 GMT
+### Additional Details
+ * Last updated: Wed, 09 Sep 2020 21:18:32 GMT
  * Dependencies: none
- * Global values: platform
+ * Global values: `platform`
 
 # Credits
-These definitions were written by Jake Hickman <https://github.com/JakeH>.
+These definitions were written by [Jake Hickman](https://github.com/JakeH), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).

No alert changes

Improved metrics

Total package byte prevSize

5561

increased by84.2%

Lines of code

103

increased by296.15%

No dependency changes