Skip to main content

API overview

Every export, with its guide and a tested example. Full signatures: API reference.

WiremockContainer​

WiremockContainer – the builder. Also has every GenericContainer method.

APIPurposeGuideExample
new WiremockContainer(image?)Create the builder; pin the imageGuidecontainer.ts
withCommand(args)WireMock command-line optionsGuidecontainer.ts
withMappings(directory)Copy mappings/ and __files/ of a directoryGuidepayments-api.ts
withMapping(name, source)One mapping file or inline stub(s)Guidestubs.ts
withFiles(...sources)Response bodies in __files/Guidestubs.ts
withExtension(extension)A class name or TypeScript extensionGuidejava-extensions.e2e.test.ts
withExtensions(extensions)Several extensions, all or nothingGuideextensions.e2e.test.ts
withExtensionJar(jar)A JAR or directory of JARs on the class pathGuidejava-extensions.e2e.test.ts
withExtensionJars(jars)Several JARs or directories, all or nothingGuidejava-extensions.e2e.test.ts
withExtensionOptions(options)Extension scanning and class-name verificationGuidejava-extensions.e2e.test.ts
start()Validate and start WireMockGuidelifecycle.e2e.test.ts

StartedWiremockContainer​

StartedWiremockContainer – what start() resolves to. Also has every Testcontainers started-container method: stop(), logs(), await using, ….

APIPurposeGuideExample
rpcUrlBase URL, e.g. http://localhost:32768Guidelifecycle.e2e.test.ts
getUrl(path?)Absolute URL of a pathGuidelifecycle.e2e.test.ts
getAdminUrl()<rpcUrl>/__adminGuidelifecycle.e2e.test.ts
getMappingUrl()<rpcUrl>/__admin/mappingsGuideisolation.ts
isRunning()Whether WireMock is healthy; never throwsGuidelifecycle.e2e.test.ts
waitUntilReady(options?)Poll until healthyGuidelifecycle.e2e.test.ts
reset()Registered stubs, restarted scenarios, empty journalGuideisolation.e2e.test.ts
resetRequests()Empty the journal onlyGuideisolation.e2e.test.ts
countRequests(criteria)Number of matching requestsGuideverification.e2e.test.ts
findRequests(criteria)The matching requestsGuideverification.e2e.test.ts
new StartedWiremockContainer(container, url)Created by start() – you do not call itGuidelifecycle.e2e.test.ts

Running without Docker​

Also exported from @hellaweb3/wiremock-testcontainers-nodejs/no-docker.

APIPurposeGuideExample
installNoDockerRuntime(options?)Serve WireMock from a local JVM – local development onlyGuideno-docker.setup.ts
isNoDockerRequested(env?)Whether WIREMOCK_NO_DOCKER is 1 or trueGuidevitest.config.ts
detectCI(env?)The CI/CD variable that is set, if anyGuideno-docker.test.ts
NO_DOCKER_ENV"WIREMOCK_NO_DOCKER"Guidetest-e2e.mjs

Types​

APIPurposeGuideExample
WiremockRequestCriteriaRequest-matching criteria for the journalGuideverification.ts
RecordedRequestA request from the journalGuideverification.ts
WaitUntilReadyOptionstimeout and interval of waitUntilReady()Guidelifecycle.ts
WiremockStubMappingA stub: request, response and moreGuidestubs.ts
WiremockMappingSourceWhat withMapping() acceptsGuidestubs.ts
WiremockFileSourceA path, URL, { file }, { module, file } or { package, file }Guidesources.ts
WiremockStaticFileA file source with an optional nameGuidesources.ts
WiremockPathA path or file: URLGuidesources.ts
WireMockExtensionThe contract of TypeScript extensionsGuidejava-extension.ts
ExtensionInputWhat withExtension() acceptsGuideregistry.ts
ExtensionConstructorAn extension class with a no-argument constructorGuideregistry.ts
WiremockExtensionJarWhat withExtensionJar() acceptsGuidejars.ts
WiremockExtensionOptionsscanning and verifyClassNamesGuidejava-extensions.e2e.test.ts
NoDockerOptionsOptions of installNoDockerRuntime()Guideno-docker.ts