isbot/index.d.ts

🤖/👨‍🦰 Recognise bots/crawlers/spiders using the user agent string.

export declare function getPattern(): RegExp;
/**
 * A list of bot identifiers to be used in a regular expression against user agent strings.
 */
export declare const list: string[];
/**
 * Check if the given user agent includes a bot pattern. Naive implementation (less accurate).
 */
export declare const isbotNaive: (userAgent?: string | null) => boolean;
/**
 * Check if the given user agent includes a bot pattern.
 */
export declare function isbot(userAgent?: string | null): boolean;
/**
 * Create a custom isbot function with a custom pattern.
 */
export declare const createIsbot: (customPattern: RegExp) => ((userAgent?: string | null) => boolean);
/**
 * Create a custom isbot function with a custom pattern.
 */
export declare const createIsbotFromList: (list: string[]) => ((userAgent: string) => boolean);
/**
 * Find the first part of the user agent that matches a bot pattern.
 */
export declare const isbotMatch: (userAgent?: string | null) => string | null;
/**
 * Find all parts of the user agent that match a bot pattern.
 */
export declare const isbotMatches: (userAgent?: string | null) => string[];
/**
 * Find the first bot pattern that match the given user agent.
 */
export declare const isbotPattern: (userAgent?: string | null) => string | null;
/**
 * Find all bot patterns that match the given user agent.
 */
export declare const isbotPatterns: (userAgent?: string | null) => string[];