Skip to content

Commit

Permalink
Adjusted readme table
Browse files Browse the repository at this point in the history
  • Loading branch information
@omrilotan
omrilotan committed Jan 2, 2024
1 parent baafa23 commit 534cf83
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ Using JSDeliver CDN you can import an iife script

## Additional named imports

| import | Type | Description |
| ------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------- |
| pattern | _{RegExp}_ | The regular expression used to identify bots |
| list | _{string[]}_ | List of all individual pattern parts |
| isbotMatch | _{(userAgent: string): string \| null}_ | The substring matched by the regular expression |
| isbotMatches | _{(userAgent: string): string[]}_ | All substrings matched by the regular expression |
| isbotPattern | _{(userAgent: string): string \| null}_ | The regular expression used to identify bot substring in the user agent |
| isbotPatterns | _{(userAgent: string): string[]}_ | All regular expressions used to identify bot substrings in the user agent |
| createIsbot | _{(pattern: RegExp): (userAgent: string): boolean}_ | Create a custom isbot function |
| createIsbotFromList | _{(list: string): (userAgent: string): boolean}_ | Create a custom isbot function from a list of string representation patterns |
| import | Type | Description |
| ------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------- |
| pattern | _RegExp_ | The regular expression used to identify bots |
| list | _string[]_ | List of all individual pattern parts |
| isbotMatch | _(userAgent: string): string \| null_ | The substring matched by the regular expression |
| isbotMatches | _(userAgent: string): string[]_ | All substrings matched by the regular expression |
| isbotPattern | _(userAgent: string): string \| null_ | The regular expression used to identify bot substring in the user agent |
| isbotPatterns | _(userAgent: string): string[]_ | All regular expressions used to identify bot substrings in the user agent |
| createIsbot | _(pattern: RegExp): (userAgent: string): boolean_ | Create a custom isbot function |
| createIsbotFromList | _(list: string): (userAgent: string): boolean_ | Create a custom isbot function from a list of string representation patterns |

## Example usages of helper functions

Expand Down

0 comments on commit 534cf83

Please sign in to comment.