Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hemant-fundwave committed Nov 14, 2024
1 parent b524b15 commit 0e4f23c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@ const fetch = MyFetchQueue.getFetchMethod();

## Options

| `Property` | `Description` | `Default Value` |
| ---------- | ----------------------------------- | --------------- |
| concurrent | number of concurrent fetch requests | 3 |
| debug | set debug mode | false |
| `Property` | `Description` | `Default Value` |
| ----------------- | ------------------------------------------------- | -------------- |
| concurrent | number of concurrent fetch requests | 3 |
| pauseQueueOnInit | pause queue from the start | false |
| pre | array of configs for pre-fetch-hooks | [] |
| queuingPatterns | array of regular-expressions evaluate | [] |
| debug | set debug mode | false |
| keyBuilderParams | array of fetch parameters to build the queue key | ["url", "options.method", "options.body"] |

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ export class FetchQueue {
#queuingPatterns: RegExp[];

/**
* Array of keys of parameters to the fetch method to build the queue key
* Array of fetch parameters to build the queue key."
*/
#keyBuilderParams: Array<string>;

Expand Down

0 comments on commit 0e4f23c

Please sign in to comment.