Incorrect metadata types

[JaneJeon]

Incorrect metadata types

[JaneJeon]

Oh, lang is missing as well (from metascraper-lang)

[Kikobeats]

@JaneJeon I will accept a PR fixing this 🙏

[JaneJeon]

What is the preferred way to resolve this? Just make the output contain every single possible type and make it nullable (and optional)? Or somehow compose types package by package?

(I have no idea how you would go about approach 2 - my typescript-fu is too weak)

[Kikobeats]

Any rule can return string/number/whatever but also null; null means the value isn't being resolved: https://github.com/microlinkhq/metascraper/blob/master/packages/metascraper/src/get-data.js#L6

I think it could be as simple as:

interface Metadata {
  author: string | null;
  date: string | null;
  description: string | null;
  image: string | null;
  publisher: string | null;
  title: string | null;
  url: string | null;
}

About why lang is missing, it's tricky because every property has its package. The lang will be present if metascraper-lang is is loaded.

What could be nice is to add every property added by any metascraper package with a little description, such as:

interface Metadata {
  /* Get lang property from HTML markup. It will be present when `metascraper-lang` is required */
  lang: string | null
}