Skip to content

@vowel.to/client v0.1.2-393


@vowel.to/client / index / createTanStackAdapters

Function: createTanStackAdapters()

ts
function createTanStackAdapters(options): {
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
};

Defined in: lib/vowel/adapters/helpers.ts:239

Create TanStack adapters

Specialized adapters for TanStack Router with automatic route extraction.

Parameters

ParameterTypeDescription
optionsTanStackAdaptersOptionsConfiguration options

Returns

ts
{
  navigationAdapter: NavigationAdapter;
  automationAdapter?: AutomationAdapter;
}

Navigation and automation adapters

NameTypeDefined in
navigationAdapterNavigationAdapterlib/vowel/adapters/helpers.ts:240
automationAdapter?AutomationAdapterlib/vowel/adapters/helpers.ts:241

Example

ts
import { createTanStackAdapters } from '@vowel.to/client/adapters/helpers';
import { Vowel } from '@vowel.to/client';
import { useRouter } from '@tanstack/react-router';

const router = useRouter();

const { navigationAdapter, automationAdapter } = createTanStackAdapters({
  router,
  enableAutomation: true
});

const vowel = new Vowel({
  appId: 'app-id',
  navigationAdapter,
  automationAdapter
});