Skip to content

core-node Functions

Functions from index.ts

Functions exported from index.ts

analyzeMdxNative

function analyzeMdxNative(source: string, filename: string, options?: MdxOptions): MdxAnalysisResult

Parameters

NameTypeDescription
sourcestring-
filenamestring-
options (optional)MdxOptions-

Returns

MdxAnalysisResult

Source


analyzeSourceNative

function analyzeSourceNative(source: string, filename: string, options?: SourceAnalysisOptions): SourceAnalysisResult

Parameters

NameTypeDescription
sourcestring-
filenamestring-
options (optional)SourceAnalysisOptions-

Returns

SourceAnalysisResult

Source


applyTranslationPatches

function applyTranslationPatches(request: TranslationPatchRequest): TranslationPatchResult

Parameters

NameTypeDescription
requestTranslationPatchRequest-

Returns

TranslationPatchResult

Source


applyTranslationPatchesAsync

function applyTranslationPatchesAsync(request: TranslationPatchRequest): Promise<TranslationPatchResult>

Parameters

NameTypeDescription
requestTranslationPatchRequest-

Returns

Promise<TranslationPatchResult>

Source


auditCatalogs

function auditCatalogs(config: CatalogArtifactConfig, options: CatalogAuditOptions): CatalogAuditResult

Parameters

NameTypeDescription
configCatalogArtifactConfig-
optionsCatalogAuditOptions-

Returns

CatalogAuditResult

Source


combineCatalogFiles

function combineCatalogFiles(request: CatalogFileCombineRequest): CatalogFileCombineResult

Parameters

NameTypeDescription
requestCatalogFileCombineRequest-

Returns

CatalogFileCombineResult

Source


combineCatalogs

function combineCatalogs(request: CatalogCombineRequest): CatalogCombineResult

Parameters

NameTypeDescription
requestCatalogCombineRequest-

Returns

CatalogCombineResult

Source


compileCatalogArtifact

function compileCatalogArtifact(config: CatalogArtifactConfig, resourcePath: string): CatalogArtifactResult

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-

Returns

CatalogArtifactResult

Source


compileCatalogArtifactAsync

function compileCatalogArtifactAsync(config: CatalogArtifactConfig, resourcePath: string): Promise<CatalogArtifactResult>

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-

Returns

Promise<CatalogArtifactResult>

Source


compileCatalogArtifactSelected

function compileCatalogArtifactSelected(config: CatalogArtifactConfig, resourcePath: string, compiledIds: string[]): CatalogArtifactResult

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-
compiledIdsstring[]-

Returns

CatalogArtifactResult

Source


compileCatalogArtifactSelectedAsync

function compileCatalogArtifactSelectedAsync(config: CatalogArtifactConfig, resourcePath: string, compiledIds: string[]): Promise<CatalogArtifactResult>

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-
compiledIdsstring[]-

Returns

Promise<CatalogArtifactResult>

Source


compileCatalogModule

function compileCatalogModule(config: CatalogArtifactConfig, resourcePath: string, options: CatalogModuleOptions): CatalogModuleResult

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-
optionsCatalogModuleOptions-

Returns

CatalogModuleResult

Source


compileCatalogModuleAsync

function compileCatalogModuleAsync(config: CatalogArtifactConfig, resourcePath: string, options: CatalogModuleOptions): Promise<CatalogModuleResult>

Parameters

NameTypeDescription
configCatalogArtifactConfig-
resourcePathstring-
optionsCatalogModuleOptions-

Returns

Promise<CatalogModuleResult>

Source


deriveMessageMetadata

function deriveMessageMetadata(message: string, context?: string): MessageMetadata

Parameters

NameTypeDescription
messagestring-
context (optional)string-

Returns

MessageMetadata

Source


extractCatalogMessagesFromFiles

function extractCatalogMessagesFromFiles(request: ExtractCatalogMessagesRequest): ExtractCatalogMessagesResult

Parameters

NameTypeDescription
requestExtractCatalogMessagesRequest-

Returns

ExtractCatalogMessagesResult

Source


extractCatalogMessagesFromFilesAsync

function extractCatalogMessagesFromFilesAsync(request: ExtractCatalogMessagesRequest): Promise<ExtractCatalogMessagesResult>

Parameters

NameTypeDescription
requestExtractCatalogMessagesRequest-

Returns

Promise<ExtractCatalogMessagesResult>

Source


extractMessagesNative

function extractMessagesNative(source: string, filename: string, options?: MdxOptions): NativeExtractedMessage[]

Parameters

NameTypeDescription
sourcestring-
filenamestring-
options (optional)MdxOptions-

Returns

NativeExtractedMessage[]

Source


getNativeInfo

function getNativeInfo(): NativeInfo

Returns

NativeInfo

Source


isTranslationPatchWriteError

function isTranslationPatchWriteError(error: unknown): error is TranslationPatchWriteError

Parameters

NameTypeDescription
errorunknown-

Returns

error is TranslationPatchWriteError

Source


listTranslationCandidates

function listTranslationCandidates(request: TranslationCandidateRequest): TranslationCandidateResult

Parameters

NameTypeDescription
requestTranslationCandidateRequest-

Returns

TranslationCandidateResult

Source


mergeCatalogFilesThreeWay

function mergeCatalogFilesThreeWay(request: CatalogFileThreeWayMergeRequest): CatalogFileCombineResult

Parameters

NameTypeDescription
requestCatalogFileThreeWayMergeRequest-

Returns

CatalogFileCombineResult

Source


mergeCatalogsThreeWay

function mergeCatalogsThreeWay(request: CatalogThreeWayMergeRequest): CatalogCombineResult

Parameters

NameTypeDescription
requestCatalogThreeWayMergeRequest-

Returns

CatalogCombineResult

Source


normalizeMessageMetadata

function normalizeMessageMetadata(input: MessageMetadataInput): MessageMetadata

Parameters

NameTypeDescription
inputMessageMetadataInput-

Returns

MessageMetadata

Source


parseCatalog

function parseCatalog(request: CatalogParseRequest): CatalogParseResult

Parameters

NameTypeDescription
requestCatalogParseRequest-

Returns

CatalogParseResult

Source


parsePo

function parsePo(source: string): ParsedPoFile

Parameters

NameTypeDescription
sourcestring-

Returns

ParsedPoFile

Source


renderCatalogModule

function renderCatalogModule(messages: Record<string, string>): string

Parameters

NameTypeDescription
messagesRecord<string, string>-

Returns

string

Source


transformMacrosNative

function transformMacrosNative(source: string, filename: string, options?: NativeTransformOptions): NativeTransformResult

Parameters

NameTypeDescription
sourcestring-
filenamestring-
options (optional)NativeTransformOptions-

Returns

NativeTransformResult

Source


updateCatalogFile

function updateCatalogFile(request: CatalogUpdateRequest): CatalogUpdateResult

Parameters

NameTypeDescription
requestCatalogUpdateRequest-

Returns

CatalogUpdateResult

Source


updateCatalogFileAsync

function updateCatalogFileAsync(request: CatalogUpdateRequest): Promise<CatalogUpdateResult>

Parameters

NameTypeDescription
requestCatalogUpdateRequest-

Returns

Promise<CatalogUpdateResult>

Source


validateMessageMetadata

function validateMessageMetadata(input: MessageMetadataInput): MessageMetadataValidationReport

Parameters

NameTypeDescription
inputMessageMetadataInput-

Returns

MessageMetadataValidationReport

Source