@types/android-device-list v1.2.3

Installation

npm install --save @types/android-device-list

Summary

This package contains type definitions for android-device-list (https://github.com/pbakondy/android-device-list#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/android-device-list.

index.d.ts

// Type definitions for android-device-list 1.2
// Project: https://github.com/pbakondy/android-device-list#readme
// Definitions by: Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * Returns the full device list
 */
export function deviceList(): Device[];

/**
 * Returns the full brand list
 */
export function brandList(): string[];

/**
 * Returns a device list with matching retail brand.
 */
export function getDevicesByBrand(brand: string, options?: Options): Device[];

/**
 * Returns a device list with matching marketing name.
 */
export function getDevicesByName(name: string, options?: Options): Device[];

/**
 * Returns a device list with matching build.os.DEVICE.
 */
export function getDevicesByDeviceId(deviceId: string, options?: Options): Device[];

/**
 * Returns a device list with matching build.os.MODEL.
 */
export function getDevicesByModel(model: string, Options?: Options): Device[];

export interface Options {
    /**
     * do not care of case type
     * @default false
     */
    caseInsensitive?: boolean | undefined;

    /**
     * return partial (substring) results too
     * @default false
     */
    contains?: boolean | undefined;
}

export interface Device {
    brand: string;
    name: string;
    device: string;
    model: string;
}

Additional Details

• Last updated: Wed, 07 Jul 2021 21:44:15 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Piotr Błażejewicz.