Skip to content

Commit 1dd1d6c

Browse files
Rename from kurrent -> kurrentdb
1 parent 4108d03 commit 1dd1d6c

File tree

9 files changed

+31
-31
lines changed

9 files changed

+31
-31
lines changed

docs/modules/kurrent.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/modules/kurrentdb.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# KurrentDB Module
2+
3+
[KurrentDB](https://kurrent.io) is an event sourcing database that stores data in streams of immutable events.
4+
5+
## Install
6+
7+
```bash
8+
npm install @testcontainers/kurrentdb --save-dev
9+
```
10+
11+
## Examples
12+
13+
<!--codeinclude-->
14+
[Start container:](../../packages/modules/kurrentdb/src/kurrent-container.test.ts) inside_block:startContainer
15+
<!--/codeinclude-->
16+
17+
<!--codeinclude-->
18+
[Subscribe to standard projection:](../../packages/modules/kurrentdb/src/kurrent-container.test.ts) inside_block:usingStandardProjections
19+
<!--/codeinclude-->

packages/modules/kurrent/src/index.ts

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
2-
"name": "@testcontainers/kurrent",
2+
"name": "@testcontainers/kurrentdb",
33
"version": "10.28.0",
44
"license": "MIT",
55
"keywords": [
6-
"kurrent",
6+
"kurrentdb",
77
"testing",
88
"docker",
99
"testcontainers"
1010
],
11-
"description": "Kurrent module for Testcontainers",
11+
"description": "KurrentDB module for Testcontainers",
1212
"homepage": "https://github.com/testcontainers/testcontainers-node#readme",
1313
"repository": {
1414
"type": "git",
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export { KurrentDbContainer, StartedKurrentDbContainer } from "./kurrent-db-container";

packages/modules/kurrent/src/kurrent-container.test.ts renamed to packages/modules/kurrentdb/src/kurrent-db-container.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import { KurrentDBClient, StreamSubscription } from "@kurrent/kurrentdb-client";
2-
import { KurrentContainer } from "./kurrent-container";
2+
import { KurrentDbContainer } from "./kurrent-db-container";
33

4-
describe("KurrentContainer", { timeout: 240_000 }, () => {
4+
describe("KurrentDbContainer", { timeout: 240_000 }, () => {
55
// startContainer {
66
it("should execute write and read", async () => {
7-
const container = await new KurrentContainer().start();
7+
const container = await new KurrentDbContainer().start();
88

99
const client = KurrentDBClient.connectionString(container.getConnectionString());
1010

@@ -44,7 +44,7 @@ describe("KurrentContainer", { timeout: 240_000 }, () => {
4444

4545
// usingStandardProjections {
4646
it("should use built-in projections", async () => {
47-
const container = await new KurrentContainer().start();
47+
const container = await new KurrentDbContainer().start();
4848
const client = KurrentDBClient.connectionString(container.getConnectionString());
4949

5050
await client.appendToStream("Todo-1", [

packages/modules/kurrent/src/kurrent-container.ts renamed to packages/modules/kurrentdb/src/kurrent-db-container.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import { AbstractStartedContainer, GenericContainer, Wait } from "testcontainers";
22

3-
export class StartedKurrentContainer extends AbstractStartedContainer {
3+
export class StartedKurrentDbContainer extends AbstractStartedContainer {
44
getConnectionString(): string {
55
return `esdb://${this.getHost()}:${this.getFirstMappedPort()}?tls=false`;
66
}
77
}
88

9-
export class KurrentContainer extends GenericContainer {
9+
export class KurrentDbContainer extends GenericContainer {
1010
constructor(image = "kurrentplatform/kurrentdb:25.0") {
1111
super(image);
1212

@@ -21,7 +21,7 @@ export class KurrentContainer extends GenericContainer {
2121
.withWaitStrategy(Wait.forHealthCheck());
2222
}
2323

24-
public override async start(): Promise<StartedKurrentContainer> {
25-
return new StartedKurrentContainer(await super.start());
24+
public override async start(): Promise<StartedKurrentDbContainer> {
25+
return new StartedKurrentDbContainer(await super.start());
2626
}
2727
}
File renamed without changes.

0 commit comments

Comments
 (0)