---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [project-index](../index.md) / RouteEventListener

# Interface: RouteEventListener

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:41](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L41)

An SFRA route event listener registered by middleware in the chain
(`this.on('route:BeforeComplete', fn)`). `route:Redirect` listeners run when
a step sets a redirect and the chain stops; `route:BeforeComplete` and then
`route:Complete` listeners run after the last step. The platform renders
the response in its own `route:Complete` listener, which runs before any
registered by middleware.

## Properties

### cartridge

> **cartridge**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:43](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L43)

***

### conditional?

> `optional` **conditional**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:49](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L49)

Registered inside a condition, so it may not run on every request.

***

### event

> **event**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:42](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L42)

***

### line

> **line**: `number`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:45](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L45)

***

### relPath

> **relPath**: `string`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:44](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L44)

***

### step

> **step**: `number`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:47](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L47)

Index into `chain` of the middleware that registers the listener.

***

### via?

> `optional` **via**: `"append"` \| `"prepend"`

Defined in: [packages/b2c-tooling-sdk/src/project-index/types.ts:51](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/project-index/types.ts#L51)

Set when the registering middleware was added by server.append or server.prepend.
