core.generatetypescriptdefinitions

Home > @medplum/core > generateTypeScriptDefinitions

generateTypeScriptDefinitions() function

Generates TypeScript definitions for FHIR StructureDefinitions, such as profiles.

Returns one .d.ts file per StructureDefinition, plus an index.d.ts that exports them all. Types that are not generated, such as base FHIR data types, are imported from @medplum/fhirtypes by default.

The StructureDefinitions must include a snapshot, and are indexed as a side effect.

Signature:

export declare function generateTypeScriptDefinitions(structureDefinitions: StructureDefinition[], options?: TypeScriptGeneratorOptions): Record<string, string>;

Parameters

Parameter	Type	Description
structureDefinitions	StructureDefinition[]	The StructureDefinitions to generate types for.
options	TypeScriptGeneratorOptions	(Optional) Optional generator options.

Returns:

Record<string, string>

A map of file names to TypeScript file contents.