frappe-codegen

frappe-codegen — programmatic API. Most users want the frappe-codegen CLI (see README.md); this entry point is for build scripts that want to generate types as part of their own pipeline instead of shelling out.

Example

import { createFrappeClient } from 'frappe-js-client'
import { fetchWithOptionalFollow, generateModule } from 'frappe-codegen'

const client = createFrappeClient({ url, apiVersion: 2, auth })
const metas = await fetchWithOptionalFollow(client, ['ToDo'], true)
const source = generateModule(metas)

Interfaces

• CliOverlay
• CodegenFileConfig
• DocField
• DocTypeMeta
• GenerateOptions
• ResolvedCodegenConfig

Variables

• DEFAULT_CONFIG_NAME

Functions

• assertUniqueInterfaceNames
• fetchDocTypeMeta
• fetchDocTypeMetas
• fetchWithOptionalFollow
• findDefaultConfigPath
• followChildTables
• generateInterface
• generateModule
• loadConfigFile
• mergeConfig
• resolveDocTypes
• toInterfaceName