<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@puppedo/walk-sync](./walk-sync.md) &gt; [WalkSyncOptions](./walk-sync.walksyncoptions.md)

## WalkSyncOptions interface

Options for configuring the walkSync function behavior.

**Signature:**

```typescript
export interface WalkSyncOptions 
```

## Remarks

This interface provides configuration options for the [walkSync()](./walk-sync.walksync.md) function.

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[depth?](./walk-sync.walksyncoptions.depth.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Maximum depth to walk (`1` = only files in the immediate directory)


</td></tr>
<tr><td>

[fullPathReturn?](./walk-sync.walksyncoptions.fullpathreturn.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Return full paths instead of relative paths


</td></tr>
<tr><td>

[ignoreFiles?](./walk-sync.walksyncoptions.ignorefiles.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Array of file names to ignore (e.g., `['.eslintrc.js']`<!-- -->)


</td></tr>
<tr><td>

[ignoreFolders?](./walk-sync.walksyncoptions.ignorefolders.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Array of folder names to ignore (e.g., `['node_modules', '.git']`<!-- -->)


</td></tr>
<tr><td>

[includeExtensions?](./walk-sync.walksyncoptions.includeextensions.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Array of file extensions to include (e.g., `['.ts', '.js']`<!-- -->)


</td></tr>
<tr><td>

[onlyFiles?](./walk-sync.walksyncoptions.onlyfiles.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Array of specific file names to include


</td></tr>
</tbody></table>
