Atlas

Appearance

Interface: RedcapAdapter ​

Defined in: packages/redcap-client/src/adapters/types.ts:22

Interface for adapting REDCap API requests/responses based on server version.

Each adapter handles the differences between REDCap versions, including:

  • Parameter name/format changes
  • Endpoint availability
  • Response schema differences

Properties ​

getDefaultParams ​

readonly getDefaultParams: () => TransformedParams

Defined in: packages/redcap-client/src/adapters/types.ts:70

Get any version-specific default parameters.

Returns ​

TransformedParams

Default parameters to include in all requests

getFeatures ​

readonly getFeatures: () => RedcapFeatures

Defined in: packages/redcap-client/src/adapters/types.ts:77

Get supported features for this version.

Returns ​

RedcapFeatures

Object describing feature availability

isEndpointAvailable ​

readonly isEndpointAvailable: (content, action?) => boolean

Defined in: packages/redcap-client/src/adapters/types.ts:63

Check if a specific endpoint/content type is available in this version.

Parameters ​

content ​

string

The REDCap content type (e.g., 'record', 'metadata')

action? ​

string

Optional action (e.g., 'export', 'import')

Returns ​

boolean

true if the endpoint is available

maxVersion ​

readonly maxVersion: Version | undefined

Defined in: packages/redcap-client/src/adapters/types.ts:30

Maximum REDCap version supported by this adapter (exclusive)

minVersion ​

readonly minVersion: Version

Defined in: packages/redcap-client/src/adapters/types.ts:27

Minimum REDCap version supported by this adapter (inclusive)

name ​

readonly name: string

Defined in: packages/redcap-client/src/adapters/types.ts:24

Human-readable name for this adapter

parseProjectInfo ​

readonly parseProjectInfo: (response) => object

Defined in: packages/redcap-client/src/adapters/types.ts:54

Parse and normalize the project info response.

Parameters ​

response ​

unknown

Raw response from REDCap

Returns ​

Normalized ProjectInfo object

creation_time ​

creation_time: string

Description ​

ISO 8601 timestamp of project creation

Example ​
ts
2024-01-15 10:30:00
in_production ​

in_production: 0 | 1

project_id ​

project_id: number

Description ​

Unique project identifier

project_title ​

project_title: string

Description ​

Human-readable project title

record_autonumbering_enabled ​

record_autonumbering_enabled: 0 | 1

transformExportParams ​

readonly transformExportParams: (params) => TransformedParams

Defined in: packages/redcap-client/src/adapters/types.ts:38

Transform export records parameters for this version.

Parameters ​

params ​

TransformedParams

The base parameters

Returns ​

TransformedParams

Transformed parameters suitable for this REDCap version

transformImportParams ​

readonly transformImportParams: (params) => TransformedParams

Defined in: packages/redcap-client/src/adapters/types.ts:46

Transform import records parameters for this version.

Parameters ​

params ​

TransformedParams

The base parameters

Returns ​

TransformedParams

Transformed parameters suitable for this REDCap version