Docs parity - device

types/device.d.ts

@@ -1,74 +1,86 @@
 declare module 'fastly:device' {
+  /**
+   * Provides device detection based on User-Agent strings.
+   *
+   * **Note**: Can only be used when processing requests, not during build-time initialization.
+   *
+   * @version 3.10.0
+   */
   class Device {
     /**
      * Look up the data associated with a particular User-Agent string.
      * If there is data associated with the User-Agent, a `Device` instance is returned.
      * Otherwise, `null` is returned.
-     * @param useragent The User-Agent string to look up
+     *
+     * @param useragent The User-Agent string to look up.
+     * @throws `TypeError` if the provided User-Agent string is empty.
      */
     static lookup(useragent: string): Device | null;
 
     /**
-     * The name of the device.
-     * If no name is known, the value will be `null`.
+     * The name of the device, or `null` if no name is known.
      */
     get name(): string | null;
     /**
-     * The brand of the device, possibly different from the manufacturer of that device.
-     * If no brand is known, the value will be `null`.
+     * The brand of the device, which may be different from the manufacturer.
+     * `null` if no brand is known.
      */
     get brand(): string | null;
     /**
-     * The model of the device.
-     * If no model is known, the value will be `null`.
+     * The model of the device, or `null` if no model is known.
      */
     get model(): string | null;
     /**
-     * A string representation of the device's primary platform hardware.
-     * The most commonly used device types are also identified via boolean variables.
-     * Because a device may have multiple device types and this variable only has the primary type,
-     * we recommend using the boolean variables for logic and using this string representation for logging.
+     * A string representation of the device's primary platform hardware,
+     * or `null` if not known.
      *
-     * If primary platform hardware is not known, the value will be `null`.
+     * The most commonly used device types are also identified via boolean
+     * properties. Because a device may have multiple device types and this
+     * property only has the primary type, we recommend using the boolean
+     * properties for logic and this string representation for logging.
      */
     get hardwareType(): string | null;
     /**
-     * Either a boolean stating if the device is a desktop web browser, or `null` if the this is not known.
+     * Whether the device is a desktop web browser, or `null` if not known.
      */
     get isDesktop(): boolean | null;
     /**
-     * Either a boolean stating if the device is a video game console, or `null` if the this is not known.
+     * Whether the device is a video game console, or `null` if not known.
      */
     get isGameConsole(): boolean | null;
     /**
-     * Either a boolean stating if the device is a media player (like Blu-ray players, iPod devices, and smart speakers such as Amazon Echo), or `null` if the this is not known.
+     * Whether the device is a media player (like Blu-ray players, iPod
+     * devices, and smart speakers such as Amazon Echo), or `null` if not known.
      */
     get isMediaPlayer(): boolean | null;
     /**
-     * Either a boolean stating if the device is a mobile phone, or `null` if the this is not known.
+     * Whether the device is a mobile phone, or `null` if not known.
      */
     get isMobile(): boolean | null;
     /**
-     * Either a boolean stating if the device is a smart TV, or `null` if the this is not known.
+     * Whether the device is a smart TV, or `null` if not known.
      */
     get isSmartTV(): boolean | null;
     /**
-     * Either a boolean stating if the device is a tablet (like an iPad), or `null` if the this is not known.
+     * Whether the device is a tablet (like an iPad), or `null` if not known.
      */
     get isTablet(): boolean | null;
     /**
-     * Either a boolean stating if the device's screen is touch sensitive, or `null` if the this is not known.
+     * Whether the device's screen is touch sensitive, or `null` if not known.
      */
     get isTouchscreen(): boolean | null;
     /**
-     * Either a boolean stating if the device is a bot, or `null` if the this is not known.
+     * Whether the device is a bot, or `null` if not known.
+     *
+     * @version 3.39.0
      */
     get isBot(): boolean | null;
 
     /**
-     * The `toJSON()` method of the Device interface is a serializer; it returns a JSON representation of the Device object.
+     * Returns a JSON representation of the Device object.
      *
-     * To get a JSON string, you can use `JSON.stringify(device)` directly; it will call `toJSON()` automatically.
+     * To get a JSON string, you can use `JSON.stringify(device)` directly;
+     * it will call `toJSON()` automatically.
      */
     toJSON(): Object;
   }