Edward Betts
ea4980a5d7
Adjust European short trip heuristic from >3 days to >1 day to correctly detect when user has returned home from European trips. This fixes the April 29-30, 2023 case where the location incorrectly showed "Sankt Georg, Hamburg" instead of "Bristol" when the user was free (no events scheduled) after the foss-north trip ended on April 27. The previous logic required more than 3 days to pass before assuming return home from European countries, but for short European trips by rail/ferry, users typically return within 1-2 days. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
123 lines
2.6 KiB
Markdown
123 lines
2.6 KiB
Markdown
# Retry utility
|
|
|
|
by [Nicholas C. Zakas](https://humanwhocodes.com)
|
|
|
|
If you find this useful, please consider supporting my work with a [donation](https://humanwhocodes.com/donate) or [nominate me](https://stars.github.com/nominate/) for a GitHub Star.
|
|
|
|
## Description
|
|
|
|
A utility for retrying failed async JavaScript calls based on the error returned.
|
|
|
|
## Usage
|
|
|
|
### Node.js
|
|
|
|
Install using [npm][npm] or [yarn][yarn]:
|
|
|
|
```
|
|
npm install @humanwhocodes/retry
|
|
|
|
# or
|
|
|
|
yarn add @humanwhocodes/retry
|
|
```
|
|
|
|
Import into your Node.js project:
|
|
|
|
```js
|
|
// CommonJS
|
|
const { Retrier } = require("@humanwhocodes/retry");
|
|
|
|
// ESM
|
|
import { Retrier } from "@humanwhocodes/retry";
|
|
```
|
|
|
|
### Deno
|
|
|
|
Install using [JSR](https://jsr.io):
|
|
|
|
```shell
|
|
deno add @humanwhocodes/retry
|
|
|
|
#or
|
|
|
|
jsr add @humanwhocodes/retry
|
|
```
|
|
|
|
Then import into your Deno project:
|
|
|
|
```js
|
|
import { Retrier } from "@humanwhocodes/retry";
|
|
```
|
|
|
|
### Bun
|
|
|
|
Install using this command:
|
|
|
|
```
|
|
bun add @humanwhocodes/retry
|
|
```
|
|
|
|
Import into your Bun project:
|
|
|
|
```js
|
|
import { Retrier } from "@humanwhocodes/retry";
|
|
```
|
|
|
|
### Browser
|
|
|
|
It's recommended to import the minified version to save bandwidth:
|
|
|
|
```js
|
|
import { Retrier } from "https://cdn.skypack.dev/@humanwhocodes/retry?min";
|
|
```
|
|
|
|
However, you can also import the unminified version for debugging purposes:
|
|
|
|
```js
|
|
import { Retrier } from "https://cdn.skypack.dev/@humanwhocodes/retry";
|
|
```
|
|
|
|
## API
|
|
|
|
After importing, create a new instance of `Retrier` and specify the function to run on the error. This function should return `true` if you want the call retried and `false` if not.
|
|
|
|
```js
|
|
// this instance will retry if the specific error code is found
|
|
const retrier = new Retrier(error => {
|
|
return error.code === "ENFILE" || error.code === "EMFILE";
|
|
});
|
|
```
|
|
|
|
Then, call the `retry()` method around the function you'd like to retry, such as:
|
|
|
|
```js
|
|
import fs from "fs/promises";
|
|
|
|
const retrier = new Retrier(error => {
|
|
return error.code === "ENFILE" || error.code === "EMFILE";
|
|
});
|
|
|
|
const text = await retrier.retry(() => fs.readFile("README.md", "utf8"));
|
|
```
|
|
|
|
The `retry()` method will either pass through the result on success or wait and retry on failure. Any error that isn't caught by the retrier is automatically rejected so the end result is a transparent passing through of both success and failure.
|
|
|
|
## Developer Setup
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork
|
|
3. Run `npm install` to setup dependencies
|
|
4. Run `npm test` to run tests
|
|
|
|
## License
|
|
|
|
Apache 2.0
|
|
|
|
## Prior Art
|
|
|
|
This utility is inspired by, and contains code from [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).
|
|
|
|
[npm]: https://npmjs.com/
|
|
[yarn]: https://yarnpkg.com/
|