valkyr/testcontainers
1
0
Fork 0
Code Issues Actions Wiki Activity

feat: update readme

Browse Source
This commit is contained in:
kodemon
2025-04-17 17:36:24 +00:00
parent ff1d59ca8c
commit 26b3e852ef
2 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
LICENSE
View File

@@ -8,6 +8,9 @@ Software, and to permit persons to whom the Software is furnished to do so, subj
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
**Commercial use is permitted, provided the Software is not sold, relicensed, or distributed as a stand-alone solution, whether in original or minimally modified form.
Use as part of a larger work, integrated product, or service is allowed.**
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

17
README.md
View File

@@ -8,6 +8,10 @@ Test container solution for running third party solutions through docker.
## Quick Start ## Quick Start
We have quick start support for `postgres` and `mongodb`.
### Postgres
```ts ```ts
import { PostgresTestContainer } from "@valkyr/testcontainers/postgres"; import { PostgresTestContainer } from "@valkyr/testcontainers/postgres";
@@ -20,3 +24,16 @@ console.log(container.url("db")); // => postgres://postgres:postgres@127.0.0.1:5
await container.stop(); await container.stop();
``` ```
### MongoDB
```ts
import { MongoTestContainer } from "@valkyr/testcontainers/mongodb";
const container = await MongoTestContainer.start();
console.log(container.url()); // mongodb://user:pass@127.0.0.1:27017
console.log(await container.client.db("admin").command({ ping: 1 })) // { ok: 1 }
await container.stop();
```