Atlas

Appearance

Interface: RedcapClient ​

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

REDCap API client interface.

The client automatically detects the REDCap server version and adapts its requests accordingly. Methods that require version-specific behavior may fail with VersionParseError or UnsupportedVersionError.

Properties ​

downloadPdf ​

readonly downloadPdf: (recordId, instrument) => Effect<ArrayBuffer, RedcapHttpError | RedcapNetworkError>

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

Parameters ​

recordId ​

RecordId

instrument ​

InstrumentName

Returns ​

Effect<ArrayBuffer, RedcapHttpError | RedcapNetworkError>

exportFile ​

readonly exportFile: (field, recordId) => Effect<ArrayBuffer, RedcapHttpError | RedcapNetworkError>

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

Parameters ​

field ​

string

recordId ​

string

Returns ​

Effect<ArrayBuffer, RedcapHttpError | RedcapNetworkError>

exportRecords ​

readonly exportRecords: <T>(options?) => Effect<readonly T[], RedcapClientError>

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

Type Parameters ​

T ​

T

Parameters ​

options? ​

ExportRecordsOptions

Returns ​

Effect<readonly T[], RedcapClientError>

findUserIdByEmail ​

readonly findUserIdByEmail: (email) => Effect<string | null, RedcapClientError>

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

Parameters ​

email ​

string

Returns ​

Effect<string | null, RedcapClientError>

getExportFieldNames ​

readonly getExportFieldNames: () => Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

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

Returns ​

Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

getFields ​

readonly getFields: () => Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

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

Returns ​

Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

getInstruments ​

readonly getInstruments: () => Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

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

Returns ​

Effect<readonly object[], RedcapHttpError | RedcapApiError | RedcapNetworkError>

getProjectInfo ​

readonly getProjectInfo: () => Effect<{ creation_time: string; in_production: 0 | 1; project_id: number; project_title: string; record_autonumbering_enabled: 0 | 1; }, RedcapClientError>

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

Returns ​

Effect<{ creation_time: string; in_production: 0 | 1; project_id: number; project_title: string; record_autonumbering_enabled: 0 | 1; }, RedcapClientError>

readonly getSurveyLink: (record, instrument) => Effect<string, RedcapHttpError | RedcapNetworkError>

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

Parameters ​

record ​

RecordId

instrument ​

InstrumentName

Returns ​

Effect<string, RedcapHttpError | RedcapNetworkError>

getVersion ​

readonly getVersion: () => Effect<string, RedcapHttpError | RedcapNetworkError>

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

Returns ​

Effect<string, RedcapHttpError | RedcapNetworkError>

importFile ​

readonly importFile: (field, recordId, fileName, content) => Effect<void, RedcapHttpError | RedcapNetworkError>

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

Parameters ​

field ​

string

recordId ​

string

fileName ​

string

content ​

Uint8Array

Returns ​

Effect<void, RedcapHttpError | RedcapNetworkError>

importRecords ​

readonly importRecords: (records, options?) => Effect<{ count: number; }, RedcapClientError>

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

Parameters ​

records ​

readonly Record<string, unknown>[]

options? ​

ImportRecordsOptions

Returns ​

Effect<{ count: number; }, RedcapClientError>