zloirock/core-js

[types] documenting features as typescript

Offen

#1.064 geöffnet am 25.03.2022

 (8 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (1.609 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (23.771 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Hi!

Context: in the README's features, there are block codes used to shown what's included in a feature (ex: https://github.com/zloirock/core-js/blob/v3.21.1/README.md#new-collections-methods). These blocks look a lot like typescript type declarations, but aren't.

First: shouldn't these blocks be tagged as typescript instead of javascript (sed /```js/```ts/g), so we can have proper syntax coloration?

Second: as a stepping point to #568, we could make these blocks correct typescript, so TS users can copy/paste them safely in their codebase when importing the polyfills (especially proposals).

If that's interesting, I could probably start a PR on that!

Contributor Guide