<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@puppedo/walk-sync](./walk-sync.md) &gt; [walkSync](./walk-sync.walksync.md)

## walkSync() function

Synchronously walks through a directory and its subdirectories, returning an array of file paths.

**Signature:**

```typescript
walkSync: (dir: string, options?: WalkSyncOptions) => string[]
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

dir


</td><td>

string


</td><td>

The directory to start walking from.


</td></tr>
<tr><td>

options


</td><td>

[WalkSyncOptions](./walk-sync.walksyncoptions.md)


</td><td>

_(Optional)_ Configuration options. See [WalkSyncOptions](./walk-sync.walksyncoptions.md) for details.


</td></tr>
</tbody></table>
**Returns:**

string\[\]

An array of file paths found during the walk.

## Example 1

Basic usage:

```typescript
const files = walkSync('./path/to/directory');
console.log(files);
```

## Example 2

Ignoring folders:

```typescript
const files = walkSync('./path/to/directory', {
  ignoreFolders: ['node_modules', 'dist'],
});
console.log(files);
```

## Example 3

Filtering by extension:

```typescript
const tsFiles = walkSync('./path/to/directory', {
  includeExtensions: ['.ts'],
});
console.log(tsFiles);
```

## Example 4

Limiting recursion depth:

```typescript
const files = walkSync('./path/to/directory', {
  depth: 1, // Only files directly in the directory
});
console.log(files);
```

## Example 5

Including only specific files:

```typescript
const configFiles = walkSync('./path/to/directory', {
  onlyFiles: ['package.json', 'tsconfig.json'],
});
console.log(configFiles);
```

