Function: createRedcapClient()

createRedcapClient(config, fetchFn?): RedcapClient

Defined in: packages/redcap-client/src/client.ts:436

Creates a new REDCap API client instance.

The client automatically detects the REDCap server version and adapts its requests accordingly. Version detection happens lazily on the first API call that requires version-specific behavior.

Parameters

config

RedcapConfig

REDCap connection configuration

fetchFn?

{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Optional custom fetch function (for testing)

Returns

RedcapClient

A version-aware REDCap client

Example

import { Effect } from 'effect';
import { createRedcapClient, RedcapUrl, RedcapToken } from '@univ-lehavre/crf/redcap';

const client = createRedcapClient({
  url: RedcapUrl('https://redcap.example.com/api/'),
  token: RedcapToken('AABBCCDD11223344AABBCCDD11223344'),
});

// Version is auto-detected on first call
const records = await Effect.runPromise(client.exportRecords());