@loopback/docs/site/apidocs/testlab.testsandboxoptions.md

Documentation files rendered at [https://loopback.io](https://loopback.io)

---
lang: en
title: 'API docs: testlab.testsandboxoptions'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/testlab
permalink: /doc/en/lb4/apidocs.testlab.testsandboxoptions.html
---

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@loopback/testlab](./testlab.md) &gt; [TestSandboxOptions](./testlab.testsandboxoptions.md)

## TestSandboxOptions interface

Options for a test sandbox

**Signature:**

```typescript
export interface TestSandboxOptions 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[subdir](./testlab.testsandboxoptions.subdir.md)


</td><td markdown="1">


</td><td markdown="1">

boolean \| string


</td><td markdown="1">

The `subdir` controls if/how the sandbox creates a subdirectory under the root path. It has one of the following values:

- `true`<!-- -->: Creates a unique subdirectory. This will be the default behavior. - `false`<!-- -->: Uses the root path as the target directory without creating a subdirectory. - a string such as `sub-dir-1`<!-- -->: creates a subdirectory with the given value.


</td></tr>
</tbody></table>