Skip to content

Commit

Permalink
easier to read type table
Browse files Browse the repository at this point in the history
  • Loading branch information
@omrilotan
omrilotan committed Jan 12, 2024
1 parent 3759392 commit 4157992
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,18 @@ Using JSDeliver CDN you can import an iife script
## All named imports

| import | Type | Description |
| ------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------- |
| isbot | _(userAgent: string): boolean_ | Check if the user agent is a bot |
| isbotNaive | _(userAgent: string): boolean_ | Check if the user agent is a bot using a naive pattern (less accurate) |
| 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 |
| ------------------- | ------------------------------- | ---------------------------------------------------------------------------- |
| isbot | _(string): boolean_ | Check if the user agent is a bot |
| isbotNaive | _(string): boolean_ | Check if the user agent is a bot using a naive pattern (less accurate) |
| pattern | _RegExp_ | The regular expression used to identify bots |
| list | _string[]_ | List of all individual pattern parts |
| isbotMatch | _(string): string \| null_ | The substring matched by the regular expression |
| isbotMatches | _(string): string[]_ | All substrings matched by the regular expression |
| isbotPattern | _(string): string \| null_ | The regular expression used to identify bot substring in the user agent |
| isbotPatterns | _(string): string[]_ | All regular expressions used to identify bot substrings in the user agent |
| createIsbot | _(RegExp): (string): boolean_ | Create a custom isbot function |
| createIsbotFromList | _(string[]): (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 4157992

Please sign in to comment.