Class Grid3VerbsParser

Index

Constructors

Methods

parseCustomDirectory parseInstalledLocales parseLocale parseXml parseXmlDetailed parseXmlFileDetailed parseZip parseZipDetailed

Constructors

constructor

new Grid3VerbsParser(): Grid3VerbsParser
Returns Grid3VerbsParser

Methods

parseCustomDirectory

parseCustomDirectory(
dirPath: string,
detailed?: false,
): Map<string, Grid3VerbForms>
Parse all locales from a custom directory.

The directory should have the same structure as Grid 3's Locale folder: customDir/en-GB/verbs/verbs.zip customDir/nb-NO/verbs/verbs.zip customDir/de-DE/verbs/verbs.zip

This allows users to supply morphology data copied from any Grid 3 installation without needing Grid 3 installed on this machine.
Parameters
- dirPath: string
- Optionaldetailed: false
Returns Map<string, Grid3VerbForms>
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:167
parseCustomDirectory(
dirPath: string,
detailed: true,
): Map<string, Grid3VerbFormsDetailed>
Parse all locales from a custom directory.

The directory should have the same structure as Grid 3's Locale folder: customDir/en-GB/verbs/verbs.zip customDir/nb-NO/verbs/verbs.zip customDir/de-DE/verbs/verbs.zip

This allows users to supply morphology data copied from any Grid 3 installation without needing Grid 3 installed on this machine.
Parameters
- dirPath: string
- detailed: true
Returns Map<string, Grid3VerbFormsDetailed>
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:168

parseInstalledLocales

parseInstalledLocales(
grid3InstallPath?: string,
): Promise<Map<string, Grid3VerbForms>>
Parameters
- Optionalgrid3InstallPath: string
Returns Promise<Map<string, Grid3VerbForms>>
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:126

parseLocale

parseLocale(locale: string, grid3InstallPath?: string): Promise<Grid3VerbForms>
Parameters
- locale: string
- Optionalgrid3InstallPath: string
Returns Promise<Grid3VerbForms>
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:113

parseXml

parseXml(xmlContent: string, locale?: string): Grid3VerbForms
Parameters
- xmlContent: string
- Optionallocale: string
Returns Grid3VerbForms
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:36

parseXmlDetailed

parseXmlDetailed(xmlContent: string, locale?: string): Grid3VerbFormsDetailed
Parameters
- xmlContent: string
- Optionallocale: string
Returns Grid3VerbFormsDetailed
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:58

parseXmlFileDetailed

parseXmlFileDetailed(filePath: string): Grid3VerbFormsDetailed
Parameters
- filePath: string
Returns Grid3VerbFormsDetailed
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:81

parseZip

parseZip(zipPath: string): Grid3VerbForms
Parameters
- zipPath: string
Returns Grid3VerbForms
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:88

parseZipDetailed

parseZipDetailed(zipPath: string): Grid3VerbFormsDetailed
Parameters
- zipPath: string
Returns Grid3VerbFormsDetailed
- Defined in src/utilities/analytics/morphology/grid3VerbsParser.ts:100