core-node Functions
Functions from index.ts
Functions exported from index.ts
analyzeMdxNative
function analyzeMdxNative(source: string, filename: string, options?: MdxOptions): MdxAnalysisResultParameters
| Name | Type | Description |
|---|---|---|
| source | string | - |
| filename | string | - |
| options (optional) | MdxOptions | - |
Returns
MdxAnalysisResult
analyzeSourceNative
function analyzeSourceNative(source: string, filename: string, options?: SourceAnalysisOptions): SourceAnalysisResultParameters
| Name | Type | Description |
|---|---|---|
| source | string | - |
| filename | string | - |
| options (optional) | SourceAnalysisOptions | - |
Returns
SourceAnalysisResult
applyTranslationPatches
function applyTranslationPatches(request: TranslationPatchRequest): TranslationPatchResultParameters
| Name | Type | Description |
|---|---|---|
| request | TranslationPatchRequest | - |
Returns
TranslationPatchResult
applyTranslationPatchesAsync
function applyTranslationPatchesAsync(request: TranslationPatchRequest): Promise<TranslationPatchResult>Parameters
| Name | Type | Description |
|---|---|---|
| request | TranslationPatchRequest | - |
Returns
Promise<TranslationPatchResult>
auditCatalogs
function auditCatalogs(config: CatalogArtifactConfig, options: CatalogAuditOptions): CatalogAuditResultParameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| options | CatalogAuditOptions | - |
Returns
CatalogAuditResult
combineCatalogFiles
function combineCatalogFiles(request: CatalogFileCombineRequest): CatalogFileCombineResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogFileCombineRequest | - |
Returns
CatalogFileCombineResult
combineCatalogs
function combineCatalogs(request: CatalogCombineRequest): CatalogCombineResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogCombineRequest | - |
Returns
CatalogCombineResult
compileCatalogArtifact
function compileCatalogArtifact(config: CatalogArtifactConfig, resourcePath: string): CatalogArtifactResultParameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
Returns
CatalogArtifactResult
compileCatalogArtifactAsync
function compileCatalogArtifactAsync(config: CatalogArtifactConfig, resourcePath: string): Promise<CatalogArtifactResult>Parameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
Returns
Promise<CatalogArtifactResult>
compileCatalogArtifactSelected
function compileCatalogArtifactSelected(config: CatalogArtifactConfig, resourcePath: string, compiledIds: string[]): CatalogArtifactResultParameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
| compiledIds | string[] | - |
Returns
CatalogArtifactResult
compileCatalogArtifactSelectedAsync
function compileCatalogArtifactSelectedAsync(config: CatalogArtifactConfig, resourcePath: string, compiledIds: string[]): Promise<CatalogArtifactResult>Parameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
| compiledIds | string[] | - |
Returns
Promise<CatalogArtifactResult>
compileCatalogModule
function compileCatalogModule(config: CatalogArtifactConfig, resourcePath: string, options: CatalogModuleOptions): CatalogModuleResultParameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
| options | CatalogModuleOptions | - |
Returns
CatalogModuleResult
compileCatalogModuleAsync
function compileCatalogModuleAsync(config: CatalogArtifactConfig, resourcePath: string, options: CatalogModuleOptions): Promise<CatalogModuleResult>Parameters
| Name | Type | Description |
|---|---|---|
| config | CatalogArtifactConfig | - |
| resourcePath | string | - |
| options | CatalogModuleOptions | - |
Returns
Promise<CatalogModuleResult>
deriveMessageMetadata
function deriveMessageMetadata(message: string, context?: string): MessageMetadataParameters
| Name | Type | Description |
|---|---|---|
| message | string | - |
| context (optional) | string | - |
Returns
MessageMetadata
extractCatalogMessagesFromFiles
function extractCatalogMessagesFromFiles(request: ExtractCatalogMessagesRequest): ExtractCatalogMessagesResultParameters
| Name | Type | Description |
|---|---|---|
| request | ExtractCatalogMessagesRequest | - |
Returns
ExtractCatalogMessagesResult
extractCatalogMessagesFromFilesAsync
function extractCatalogMessagesFromFilesAsync(request: ExtractCatalogMessagesRequest): Promise<ExtractCatalogMessagesResult>Parameters
| Name | Type | Description |
|---|---|---|
| request | ExtractCatalogMessagesRequest | - |
Returns
Promise<ExtractCatalogMessagesResult>
extractMessagesNative
function extractMessagesNative(source: string, filename: string, options?: MdxOptions): NativeExtractedMessage[]Parameters
| Name | Type | Description |
|---|---|---|
| source | string | - |
| filename | string | - |
| options (optional) | MdxOptions | - |
Returns
NativeExtractedMessage[]
getNativeInfo
function getNativeInfo(): NativeInfoReturns
NativeInfo
isTranslationPatchWriteError
function isTranslationPatchWriteError(error: unknown): error is TranslationPatchWriteErrorParameters
| Name | Type | Description |
|---|---|---|
| error | unknown | - |
Returns
error is TranslationPatchWriteError
listTranslationCandidates
function listTranslationCandidates(request: TranslationCandidateRequest): TranslationCandidateResultParameters
| Name | Type | Description |
|---|---|---|
| request | TranslationCandidateRequest | - |
Returns
TranslationCandidateResult
mergeCatalogFilesThreeWay
function mergeCatalogFilesThreeWay(request: CatalogFileThreeWayMergeRequest): CatalogFileCombineResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogFileThreeWayMergeRequest | - |
Returns
CatalogFileCombineResult
mergeCatalogsThreeWay
function mergeCatalogsThreeWay(request: CatalogThreeWayMergeRequest): CatalogCombineResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogThreeWayMergeRequest | - |
Returns
CatalogCombineResult
normalizeMessageMetadata
function normalizeMessageMetadata(input: MessageMetadataInput): MessageMetadataParameters
| Name | Type | Description |
|---|---|---|
| input | MessageMetadataInput | - |
Returns
MessageMetadata
parseCatalog
function parseCatalog(request: CatalogParseRequest): CatalogParseResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogParseRequest | - |
Returns
CatalogParseResult
parsePo
function parsePo(source: string): ParsedPoFileParameters
| Name | Type | Description |
|---|---|---|
| source | string | - |
Returns
ParsedPoFile
renderCatalogModule
function renderCatalogModule(messages: Record<string, string>): stringParameters
| Name | Type | Description |
|---|---|---|
| messages | Record<string, string> | - |
Returns
string
transformMacrosNative
function transformMacrosNative(source: string, filename: string, options?: NativeTransformOptions): NativeTransformResultParameters
| Name | Type | Description |
|---|---|---|
| source | string | - |
| filename | string | - |
| options (optional) | NativeTransformOptions | - |
Returns
NativeTransformResult
updateCatalogFile
function updateCatalogFile(request: CatalogUpdateRequest): CatalogUpdateResultParameters
| Name | Type | Description |
|---|---|---|
| request | CatalogUpdateRequest | - |
Returns
CatalogUpdateResult
updateCatalogFileAsync
function updateCatalogFileAsync(request: CatalogUpdateRequest): Promise<CatalogUpdateResult>Parameters
| Name | Type | Description |
|---|---|---|
| request | CatalogUpdateRequest | - |
Returns
Promise<CatalogUpdateResult>
validateMessageMetadata
function validateMessageMetadata(input: MessageMetadataInput): MessageMetadataValidationReportParameters
| Name | Type | Description |
|---|---|---|
| input | MessageMetadataInput | - |
Returns
MessageMetadataValidationReport