Class TypographistRules<TLocale>

Supplies locale rules from paired Knuth–Liang and Khristov datasets, or a subclass's own storage. Typographist calls compile once per registration with its configured useFast flag.

Example

import { TypographistRules } from '@elmenov-softworks/typographist';

const rules = new TypographistRules({
  standard: {
    locale: 'en', alphabet: 'abcd', leftMin: 1, rightMin: 1, patterns: ['a1b'],
  },
  fast: {
    locale: 'en', alphabet: 'abcd', leftMin: 1, rightMin: 1,
    vowels: 'a', consonants: 'bcd', specialLetters: '',
  },
});
rules.compile(true); // Returns Khristov classifications.

Type Parameters

TLocale extends string = string

Implements

ITypographistRules<TLocale>

Index

Constructors

constructor

Methods

compile

Constructors

constructor

new TypographistRules<TLocale extends string = string>(
ruleSets?: RuleSets<TLocale> | null,
): TypographistRules<TLocale>
Requires both datasets when supplied; omitting them requires a subclass to override compile.
Type Parameters
- TLocale extends string = string
Parameters
- ruleSets: RuleSets<TLocale> | null = null
Returns TypographistRules<TLocale>
- Defined in rules/typographist-rules.ts:26

Methods

compile

compile(useFast: boolean): CompiledRules<TLocale> | KhristovRules<TLocale>
Selects Khristov rules in fast mode and Knuth–Liang rules in standard mode. Never substitutes the other algorithm's data. Typographist validates and prepares the returned data on registration.
Parameters
- useFast: boolean
Returns CompiledRules<TLocale> | KhristovRules<TLocale>
Implementation of ITypographistRules.compile
- Defined in rules/typographist-rules.ts:44

Class TypographistRules<TLocale>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TypographistRules<TLocale>

Methods

compile

Parameters

Returns CompiledRules<TLocale> | KhristovRules<TLocale>

Settings

On This Page