Excerpt type definition seems wrong #125

New issue

Open

opened 2021-06-08 21:53:10 +00:00 by wkirby · 1 comment

wkirby commented

2021-06-08 21:53:10 +00:00

(Migrated from github.com)

The type for excerpt is declared as:

type Input = string | Buffer

interface GrayMatterOption<
    I extends Input,
    O extends GrayMatterOption<I, O>
  > {
    parser?: () => void
    eval?: boolean
    excerpt?: boolean | ((input: I, options: O) => string)
    excerpt_separator?: string
    engines?: {
      [index: string]:
        | ((input: string) => object)
        | { parse: (input: string) => object; stringify?: (data: object) => string }
    }
    language?: string
    delimiters?: string | [string, string]
  }

But the example function usage in the README is:

function firstFourLines(file, options) {
  file.excerpt = file.content.split('\n').slice(0, 4).join(' ');
}

This example function does not take a string or a Buffer — it takes a GrayMatterFile and doesn't appear to return anything.

The type, I think, should be redeclared as:

excerpt?: boolean | ((file: GrayMatterFile, options: O) => void)

The type for `excerpt` is declared as: ``` type Input = string | Buffer interface GrayMatterOption< I extends Input, O extends GrayMatterOption<I, O> > { parser?: () => void eval?: boolean excerpt?: boolean | ((input: I, options: O) => string) excerpt_separator?: string engines?: { [index: string]: | ((input: string) => object) | { parse: (input: string) => object; stringify?: (data: object) => string } } language?: string delimiters?: string | [string, string] } ``` But the example function usage in the README is: ``` function firstFourLines(file, options) { file.excerpt = file.content.split('\n').slice(0, 4).join(' '); } ``` This example function does not take a string or a Buffer — it takes a `GrayMatterFile` and doesn't appear to return anything. The type, I think, should be redeclared as: ``` excerpt?: boolean | ((file: GrayMatterFile, options: O) => void) ```

👍 1

doowb commented

2021-06-09 12:07:59 +00:00

(Migrated from github.com)