@types/random-useragent/README.md

TypeScript definitions for random-useragent

# Installation
> `npm install --save @types/random-useragent`

# Summary
This package contains type definitions for random-useragent (https://github.com/skratchdot/random-useragent).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/random-useragent.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/random-useragent/index.d.ts)
````ts
/**
 * Generated user agent object interface.
 */
export interface UserAgent {
    folder: string;
    description: string;
    userAgent: string;
    appCodename: string;
    appName: string;
    appVersion: string;
    platform: string;
    vendor: string;
    vendorSub: string;
    browserName: string;
    browserMajor: string;
    browserVersion: string;
    deviceModel: string;
    deviceType: string;
    deviceVendor: string;
    engineName: string;
    engineVersion: string;
    osName: string;
    osVersion: string;
    cpuArchitecture: string;
}

/**
 * Get a random user agent string (optionally using a filter).
 * @param [filter] - An `Array.prototype.filter()` callback function.
 */
export function getRandom(): string;

export function getRandom(filter: (value: UserAgent, index: number, array: UserAgent[]) => boolean): string | null;

/**
 * Get a random user agent's parsed data (optionally using a filter).
 * @param [filter] - An `Array.prototype.filter()` callback function.
 */
export function getRandomData(): UserAgent;

export function getRandomData(
    filter: (value: UserAgent, index: number, array: UserAgent[]) => boolean,
): UserAgent | null;

/**
 * Get an array of all the user agent strings (optionally using a filter).
 * @param [filter] - An `Array.prototype.filter()` callback function.
 */
export function getAll(filter?: (value: UserAgent, index: number, array: UserAgent[]) => boolean): string[];

/**
 * Get an array of all the parsed user agent data (optionally using a filter).
 * @param [filter] - An `Array.prototype.filter()` callback function.
 */
export function getAllData(filter?: (value: UserAgent, index: number, array: UserAgent[]) => boolean): UserAgent[];

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Jeffry Angtoni](https://github.com/jeffryang24).