crumb/types.d.ts at master · violapeter/crumb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
declare module 'crumbjs' {
  export type WordLike = string | RegExp | Array<string | RegExp>
  export type ExceptionHandler = string | ((string: string) => string)
  export type Exception = [WordLike, ExceptionHandler]
  export type SuffixerMethod = (
    word: string,
    exceptions?: Exception[],
  ) => string

  export type StopWord = string | RegExp

  export const suffix: {
    accusative: SuffixerMethod
    ablative: SuffixerMethod
    adessive: SuffixerMethod
    adjective: SuffixerMethod
    allative: SuffixerMethod
    finalCasual: SuffixerMethod
    dative: SuffixerMethod
    delative: SuffixerMethod
    elative: SuffixerMethod
    essiveFormal: SuffixerMethod
    essiveModal: SuffixerMethod
    illative: SuffixerMethod
    inessive: SuffixerMethod
    instrumentalComitative: SuffixerMethod
    locative: SuffixerMethod
    sublative: SuffixerMethod
    superessive: SuffixerMethod
    terminative: SuffixerMethod
    translative: SuffixerMethod
    privative: SuffixerMethod
    plural: SuffixerMethod
    genitive: SuffixerMethod
    temporal: SuffixerMethod
    sociative: SuffixerMethod
    distributiveTemporal: SuffixerMethod
    distributive: SuffixerMethod
    formal: SuffixerMethod
    modalEssive: SuffixerMethod
    multiplicative: SuffixerMethod
    frequentative: SuffixerMethod
  }

  export const grade: {
    comparative: SuffixerMethod
    superlative: SuffixerMethod
    excessive: SuffixerMethod
  }

  export function getNumberWithWords(number: number): string

  export function getSyllables(
    word: string,
    options?: {
      stopWords?: StopWord | StopWord[]
      formatted?: true
      hyphenCharacter?: string
    },
  ): string

  export function getSyllables(
    word: string,
    options?: {
      stopWords?: StopWord | StopWord[]
      formatted?: false
      hyphenCharacter?: string
    },
  ): string[]

  export function getSyllables(
    word: string,
    options?: {
      stopWords?: StopWord | StopWord[]
      formatted?: boolean
      hyphenCharacter?: string
    },
  ): string | string[]
}