Skip to content

Commit

Permalink
feat(repeater): update README
Browse files Browse the repository at this point in the history
closes #196
  • Loading branch information
ostridm committed Jun 18, 2024
1 parent b738876 commit ed80f20
Showing 1 changed file with 0 additions and 27 deletions.
27 changes: 0 additions & 27 deletions packages/repeater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,33 +95,6 @@ export interface RequestRunnerOptions {
}
```

The `RepeaterFactory` also provides a method to create a `Repeater` instance using an existing repeater ID. You can use the `createRepeaterFromExisting` method to accomplish this:

```ts
const existingRepeaterId = '<your repater ID>';
const repeater = await repeaterFactory.createRepeaterFromExisting(
existingRepeaterId
);
```

This method retrieves the existing repeater's details from the cloud using its ID and returns a `Repeater` instance associated with the specified ID.

You can also customize the request runner options for the existing repeater by passing them as options:

```ts
const existingRepeaterId = '<your repater ID>';
const repeater = await repeaterFactory.createRepeaterFromExisting(
existingRepeaterId,
{
requestRunnerOptions: {
timeout: 10000,
maxContentLength: 200,
allowedMimes: ['text/html']
}
}
);
```

The `Repeater` instance provides the `start` method. This method is required to establish a connection with the Bright cloud engine and interact with other services.

```ts
Expand Down

0 comments on commit ed80f20

Please sign in to comment.