Skip to main content

Class: StartedWiremockContainer

Defined in: src/index.ts:427

A started WireMock container with URL, health, reset and verification helpers – and every Testcontainers StartedTestContainer method, such as stop() and logs().

See​

Container lifecycle

Extends​

Constructors​

Constructor​

new StartedWiremockContainer(startedTestContainer, url): StartedWiremockContainer;

Defined in: src/index.ts:433

Created by WiremockContainer.start; url is WireMock's base URL.

Parameters​

ParameterType
startedTestContainerStartedTestContainer
urlstring

Returns​

StartedWiremockContainer

Overrides​

AbstractStartedContainer.constructor

Accessors​

rpcUrl​

Get Signature​

get rpcUrl(): string;

Defined in: src/index.ts:441

Base URL, e.g. http://localhost:32768.

Returns​

string

Methods​

countRequests()​

countRequests(request): Promise<number>;

Defined in: src/index.ts:533

Number of journal entries matching request since the last reset.

Parameters​

ParameterType
requestWiremockRequestCriteria

Returns​

Promise<number>

Example​

expect(await wiremock.countRequests({ method: "GET", url: "/payments" })).toBe(1); // exact path and query
expect(await wiremock.countRequests({ method: "GET", urlPath: "/payments" })).toBe(2); // any query

Throws​

If WireMock rejects the criteria, with its explanation.

See​

Verifying requests


findRequests()​

findRequests(request): Promise<RecordedRequest[]>;

Defined in: src/index.ts:544

Journal entries matching request since the last reset.

Parameters​

ParameterType
requestWiremockRequestCriteria

Returns​

Promise<RecordedRequest[]>

Throws​

If WireMock rejects the criteria, with its explanation.

See​

Verifying requests


getAdminUrl()​

getAdminUrl(): string;

Defined in: src/index.ts:461

Admin API base URL: <rpcUrl>/__admin.

Returns​

string


getMappingUrl()​

getMappingUrl(): string;

Defined in: src/index.ts:469

Stub mappings endpoint: <rpcUrl>/__admin/mappings – e.g. to add stubs at runtime.

Returns​

string

See​

Stubs added at runtime


getUrl()​

getUrl(path?): string;

Defined in: src/index.ts:452

Absolute URL for path, e.g. getUrl("cards?page=1"); no argument → rpcUrl.

Parameters​

ParameterTypeDefault value
path?string""

Returns​

string

Example​

expect(wiremock.getUrl("/payments")).toBe(`${wiremock.rpcUrl}/payments`);
expect(wiremock.getUrl("payments?page=2")).toBe(`${wiremock.rpcUrl}/payments?page=2`); // "/" added

See​

URLs


isRunning()​

isRunning(): Promise<boolean>;

Defined in: src/index.ts:477

Whether WireMock responds healthily. Never throws.

Returns​

Promise<boolean>

See​

Health checks


reset()​

reset(): Promise<void>;

Defined in: src/index.ts:513

Restores registered stubs and scenarios and clears the journal – no restart.

Returns​

Promise<void>

Example​

afterEach(() => wiremock.reset()); // pristine stubs, empty journal – no restart

See​

Test isolation


resetRequests()​

resetRequests(): Promise<void>;

Defined in: src/index.ts:521

Clears the request journal; stubs – and scenario states – are kept.

Returns​

Promise<void>

See​

Test isolation


waitUntilReady()​

waitUntilReady(options?): Promise<void>;

Defined in: src/index.ts:493

Polls isRunning until healthy.

Parameters​

ParameterType
options?WaitUntilReadyOptions

Returns​

Promise<void>

Throws​

If not healthy within options.timeout.

See​

Container lifecycle