Discussion: Any chance of having this typed for TS consumption?

[michaelpumo]

I looked on DefinitelyTyped for TypeScript types for this package but came up short.

I did a bit of work with the help of AI, to make a declaration file of my own:

declare module 'text-readability' {
  class Readability {
    static getGradeSuffix(grade: number): string
    charCount(text: string, ignoreSpaces?: boolean): number
    letterCount(text: string, ignoreSpaces?: boolean): number
    removePunctuation(text: string): string
    static split(text: string): string[]
    lexiconCount(text: string, removePunctuation?: boolean): number
    syllableCount(text: string, lang?: string): number
    sentenceCount(text: string): number
    averageSentenceLength(text: string): number
    averageSyllablePerWord(text: string): number
    averageCharacterPerWord(text: string): number
    averageLetterPerWord(text: string): number
    averageSentencePerWord(text: string): number
    fleschReadingEase(text: string): number
    fleschReadingEaseToGrade(score: number): number
    fleschKincaidGrade(text: string): number
    polySyllableCount(text: string): number
    smogIndex(text: string): number
    colemanLiauIndex(text: string): number
    automatedReadabilityIndex(text: string): number
    linsearWriteFormula(text: string): number
    presentTense(word: string): string
    difficultWords(text: string, syllableThreshold?: number): number
    difficultWordsSet(text: string, syllableThreshold?: number): Set<string>
    daleChallReadabilityScore(text: string): number
    daleChallToGrade(score: number): number
    gunningFog(text: string): number
    lix(text: string): number
    rix(text: string): number
    textStandard(text: string, floatOutput?: boolean): number | string
    textMedian(text: string): number
  }

  const readability: Readability

  export default readability
}

Not sure how you would want to handle this?

1. Users make their own text-readability.d.ts file (like this one)
2. Types supported on DefinitelyTyped (a version of this one to download)
3. Create a TS version/rewrite of this package

Would be great to discuss ideas.

Thanks.