Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: adjust exports to better accomodate ESM and/or CJS #356

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"

- package-ecosystem: "npm" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ jobs:
node-version: [18.x, 20.x]

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Start containers
run: docker-compose -f "docker-compose.yml" up -d --build

- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: npm
Expand All @@ -49,11 +49,11 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- run: npm ci
- run: npm run build
- name: Semantic Release
uses: cycjimmy/semantic-release-action@v3
uses: cycjimmy/semantic-release-action@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
6 changes: 3 additions & 3 deletions .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ jobs:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: "18"
node-version: "20"
- run: npm install
- uses: wagoid/commitlint-github-action@v5
- uses: wagoid/commitlint-github-action@v6.0.1
with:
configFile: .commitlintrc.yml
env:
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ For more information on configuring retries, see [Retry Topic Naming Strategies]
To use this module, create an `AsyncRetryHelper` object with the parameters that specify the retry delay, retry strategy, and number of retries, as in this example:

```typescript
import AsyncRetryHelper, { RetryTopicNaming } from "kafkajs-async-retry";
import { AsyncRetryHelper, RetryTopicNaming } from "kafkajs-async-retry";

const asyncRetryHelper = new AsyncRetryHelper({
producer,
Expand Down Expand Up @@ -113,8 +113,7 @@ Here's a complete example:

```typescript
const { Kafka } = require("kafkajs");
const AsyncRetryHelper,
{ RetryTopicNaming } = require("kafkajs-async-retry");
const { AsyncRetryHelper, RetryTopicNaming } = require("kafkajs-async-retry");

const kafka = new Kafka({
clientId: "my-app",
Expand Down Expand Up @@ -261,7 +260,7 @@ Here's a sequence diagram of the various topics needing when using a `DELAY_BASE

### `AsyncRetryHelper` (constructor)

This is the default export and is the primary entry point for all functionality provided by this module.
This is the default export (but also exported as a named export) and is the primary entry point for all functionality provided by this module.
It accepts a single argument, an object with the following properties:

| Property | Type | Description |
Expand Down
Loading
Loading