Skip to content

Documentation error: languageAlternates should use hreflang instead of hrefLang #27

@aersosi

Description

@aersosi

Hey there,

I noticed a discrepancy between the documentation and the actual implementation regarding the languageAlternates prop.

In the README, it's stated that the expected shape is:

{ hrefLang: string, href: string }

However, this leads to the runtime error:

TypeError: String.prototype.replace called on null or undefined

After inspecting the packages source code, I found that the correct key should be hreflang (lowercase l), not hrefLang.

{ hreflang: string, href: string }

This matches the usage and the inline doc inside the library and works without error.

Could you please update the documentation to reflect the correct key name or use camelCase. This is probably just a typo.

Thanks for the great work on this package!
Have a good one.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions